docs: document metric env variables, add job metric env #8406
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying immich with
|
| Latest commit: |
15de7ed
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://27a429da.immich.pages.dev |
| Branch Preview URL: | https://docs-server-job-metrics.immich.pages.dev |
bo0tzz
approved these changes
Mar 31, 2024
danieldietzler
approved these changes
Mar 31, 2024
jrasm91
approved these changes
Mar 31, 2024
Comment on lines
154
to
158
| | `IMMICH_METRICS`<sup>\*1</sup> | Toggle all metrics | | server, microservices | | ||
| | `IMMICH_API_METRICS` | Toggle metrics for endpoints and response times | | server, microservices | | ||
| | `IMMICH_HOST_METRICS` | Toggle metrics for CPU and memory utilization for host and process | | server, microservices | | ||
| | `IMMICH_IO_METRICS` | Toggle metrics for database queries, image processing, etc. | | server, microservices | | ||
| | `IMMICH_JOB_METRICS` | Toggle metrics for jobs and queues | | server, microservices | |
There was a problem hiding this comment.
You should include the values here do users know that to set them to.
mertalev
force-pushed
the
docs/server-job-metrics
branch
from
16fcccc
to
15de7ed
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The metric envs aren't listed in the env variable doc page. This PR adds a new section for them, changes the monitoring doc to reference this section, and adds an entry for job metrics.