public/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-11-27 07:10:00 +09:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

chore(docs): add reference to metric ports (#14887)
Some checks failed
CodeQL / Analyze (javascript) (push) Has been cancelled
Details
CodeQL / Analyze (python) (push) Has been cancelled
Details
Docker / pre-job (push) Has been cancelled
Details
Docs build / pre-job (push) Has been cancelled
Details
Static Code Analysis / pre-job (push) Has been cancelled
Details
Test / pre-job (push) Has been cancelled
Details
Test / ShellCheck (push) Has been cancelled
Details
Test / OpenAPI Clients (push) Has been cancelled
Details
Test / TypeORM Checks (push) Has been cancelled
Details
Docker / Re-Tag ML () (push) Has been cancelled
Details
Docker / Re-Tag ML (-armnn) (push) Has been cancelled
Details
Docker / Re-Tag ML (-cuda) (push) Has been cancelled
Details
Docker / Re-Tag ML (-openvino) (push) Has been cancelled
Details
Docker / Re-Tag Server () (push) Has been cancelled
Details
Docker / Build and Push ML (armnn, linux/arm64, -armnn) (push) Has been cancelled
Details
Docker / Build and Push ML (cpu, linux/amd64,linux/arm64) (push) Has been cancelled
Details
Docker / Build and Push ML (cuda, linux/amd64, -cuda) (push) Has been cancelled
Details
Docker / Build and Push ML (openvino, linux/amd64, -openvino) (push) Has been cancelled
Details
Docker / Build and Push Server (cpu, linux/amd64,linux/arm64) (push) Has been cancelled
Details
Docker / Docker Build & Push Server Success (push) Has been cancelled
Details
Docker / Docker Build & Push ML Success (push) Has been cancelled
Details
Docs build / Docs Build (push) Has been cancelled
Details
Static Code Analysis / Run Dart Code Analysis (push) Has been cancelled
Details
Test / Test & Lint Server (push) Has been cancelled
Details
Test / Unit Test CLI (push) Has been cancelled
Details
Test / Unit Test CLI (Windows) (push) Has been cancelled
Details
Test / Test & Lint Web (push) Has been cancelled
Details
Test / End-to-End Lint (push) Has been cancelled
Details
Test / Medium Tests (Server) (push) Has been cancelled
Details
Test / End-to-End Tests (Server & CLI) (push) Has been cancelled
Details
Test / End-to-End Tests (Web) (push) Has been cancelled
Details
Test / Unit Test Mobile (push) Has been cancelled
Details
Test / Unit Test ML (push) Has been cancelled
Details

Browse Source 
chore(docs): add refference to metric ports
This commit is contained in:
Felix Bühler
2024-12-28 23:49:06 +01:00
committed by GitHub
parent 34ce61d03a
commit 4448143197
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/features/monitoring.md
View File

@@ -66,7 +66,9 @@ The provided file is just a starting point. There are a ton of ways to configure
After bringing down the containers with `docker compose down` and back up with `docker compose up -d`, a Prometheus instance will now collect metrics from the immich server and microservices containers. Note that we didn't need to expose any new ports for these containers - the communication is handled in the internal Docker network. After bringing down the containers with `docker compose down` and back up with `docker compose up -d`, a Prometheus instance will now collect metrics from the immich server and microservices containers. Note that we didn't need to expose any new ports for these containers - the communication is handled in the internal Docker network.
:::note :::note
To see exactly what metrics are made available, you can additionally add `8081:8081` to the server container's ports and `8082:8082` to the microservices container's ports. Visiting the `/metrics` endpoint for these services will show the same raw data that Prometheus collects. To see exactly what metrics are made available, you can additionally add `8081:8081` to the server container's ports and `8082:8082` to the microservices container's ports.
Visiting the `/metrics` endpoint for these services will show the same raw data that Prometheus collects.
To configure these ports see [`IMMICH_API_METRICS_PORT` & `IMMICH_MICROSERVICES_METRICS_PORT`](../install/environment-variables/#general).
::: :::
### Usage ### Usage