From 82216281cee085771fa86173cdf6af6487e48512 Mon Sep 17 00:00:00 2001 From: tobi Date: Thu, 18 Sep 2025 16:48:45 +0200 Subject: [chore/docs] Fix Prometheus metric names for Gin, include example Grafana dash, update docs (#4443) # Description > If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements. > > If this is a documentation change, please briefly describe what you've changed and why. This pull request updates some of our inconsistent metric naming, and adds an example Grafana dashboard using all the most up-to-date metrics names, and updates our docs to describe the latest way of setting up metrics. Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/4362 Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/4055 ## Checklist Please put an x inside each checkbox to indicate that you've read and followed it: `[ ]` -> `[x]` If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want). - [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md). - [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat. - [x] I/we have not leveraged AI to create the proposed changes. - [x] I/we have performed a self-review of added code. - [x] I/we have written code that is legible and maintainable by others. - [x] I/we have commented the added code, particularly in hard-to-understand areas. - [x] I/we have made any necessary changes to documentation. - [ ] I/we have added tests that cover new code. - [x] I/we have run tests and they pass locally with the changes. - [x] I/we have run `go fmt ./...` and `golangci-lint run`. Co-authored-by: kim Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4443 Reviewed-by: kim Co-authored-by: tobi Co-committed-by: tobi --- docs/locales/zh/advanced/metrics.md | 2 +- docs/locales/zh/advanced/tracing.md | 2 +- docs/locales/zh/configuration/observability.md | 53 ---------------------- .../zh/configuration/observability_and_metrics.md | 53 ++++++++++++++++++++++ docs/locales/zh/mkdocs.yml | 2 +- 5 files changed, 56 insertions(+), 56 deletions(-) delete mode 100644 docs/locales/zh/configuration/observability.md create mode 100644 docs/locales/zh/configuration/observability_and_metrics.md (limited to 'docs/locales') diff --git a/docs/locales/zh/advanced/metrics.md b/docs/locales/zh/advanced/metrics.md index a9110bf91..1984327cc 100644 --- a/docs/locales/zh/advanced/metrics.md +++ b/docs/locales/zh/advanced/metrics.md @@ -54,4 +54,4 @@ location /metrics { [otel]: https://opentelemetry.io/ [prom]: https://prometheus.io/docs/instrumenting/exposition_formats/ -[obs]: ../configuration/observability.md \ No newline at end of file +[obs]: ../configuration/observability_and_metrics.md \ No newline at end of file diff --git a/docs/locales/zh/advanced/tracing.md b/docs/locales/zh/advanced/tracing.md index 10e9f42fc..15e518330 100644 --- a/docs/locales/zh/advanced/tracing.md +++ b/docs/locales/zh/advanced/tracing.md @@ -16,7 +16,7 @@ tracing-insecure-transport: true ``` [otel]: https://opentelemetry.io/ -[obs]: ../configuration/observability.md +[obs]: ../configuration/observability_and_metrics.md [tempo]: https://grafana.com/oss/tempo/ [grafana]: https://grafana.com/oss/grafana/ [ext]: https://codeberg.org/superseriousbusiness/gotosocial/tree/main/example/tracing diff --git a/docs/locales/zh/configuration/observability.md b/docs/locales/zh/configuration/observability.md deleted file mode 100644 index c26b2b351..000000000 --- a/docs/locales/zh/configuration/observability.md +++ /dev/null @@ -1,53 +0,0 @@ -# 可观测性 - -这些设置允许你调整和配置某些与可观测性相关的行为。 - -## 指标 - -在启用指标之前，[请阅读指南](../advanced/metrics.md)，并确保你已为设置采取适当的安全措施。 - -## 设置 - -```yaml -################################## -##### 可观测性设置 ##### -################################## - -# 字符串。用于提取请求或跟踪ID的请求头名称。通常由负载均衡器或代理设置。 -# 默认值: "X-Request-Id" -request-id-header: "X-Request-Id" - -# 布尔值。启用基于OpenTelemetry的跟踪支持。 -# 默认值: false -tracing-enabled: false - -# 字符串。设置跟踪系统的传输协议。可以是 "grpc" 表示OTLP gRPC，或 "http" 表示OTLP HTTP。 -# 选项: ["grpc", "http"] -# 默认值: "grpc" -tracing-transport: "grpc" - -# 字符串。跟踪收集器的端点。使用gRPC或HTTP传输时，应提供不含协议方案的地址/端口组合。 -# 示例: ["localhost:4317"] -# 默认值: "" -tracing-endpoint: "" - -# 布尔值。禁用gRPC和HTTP传输协议的TLS。 -# 默认值: false -tracing-insecure-transport: false - -# 布尔值。启用基于OpenTelemetry的指标支持。 -# 默认值: false -metrics-enabled: false - -# 布尔值。为Prometheus指标端点启用HTTP基本认证。 -# 默认值: false -metrics-auth-enabled: false - -# 字符串。Prometheus指标端点的用户名。 -# 默认值: "" -metrics-auth-username: "" - -# 字符串。Prometheus指标端点的密码。 -# 默认值: "" -metrics-auth-password: "" -``` diff --git a/docs/locales/zh/configuration/observability_and_metrics.md b/docs/locales/zh/configuration/observability_and_metrics.md new file mode 100644 index 000000000..c26b2b351 --- /dev/null +++ b/docs/locales/zh/configuration/observability_and_metrics.md @@ -0,0 +1,53 @@ +# 可观测性 + +这些设置允许你调整和配置某些与可观测性相关的行为。 + +## 指标 + +在启用指标之前，[请阅读指南](../advanced/metrics.md)，并确保你已为设置采取适当的安全措施。 + +## 设置 + +```yaml +################################## +##### 可观测性设置 ##### +################################## + +# 字符串。用于提取请求或跟踪ID的请求头名称。通常由负载均衡器或代理设置。 +# 默认值: "X-Request-Id" +request-id-header: "X-Request-Id" + +# 布尔值。启用基于OpenTelemetry的跟踪支持。 +# 默认值: false +tracing-enabled: false + +# 字符串。设置跟踪系统的传输协议。可以是 "grpc" 表示OTLP gRPC，或 "http" 表示OTLP HTTP。 +# 选项: ["grpc", "http"] +# 默认值: "grpc" +tracing-transport: "grpc" + +# 字符串。跟踪收集器的端点。使用gRPC或HTTP传输时，应提供不含协议方案的地址/端口组合。 +# 示例: ["localhost:4317"] +# 默认值: "" +tracing-endpoint: "" + +# 布尔值。禁用gRPC和HTTP传输协议的TLS。 +# 默认值: false +tracing-insecure-transport: false + +# 布尔值。启用基于OpenTelemetry的指标支持。 +# 默认值: false +metrics-enabled: false + +# 布尔值。为Prometheus指标端点启用HTTP基本认证。 +# 默认值: false +metrics-auth-enabled: false + +# 字符串。Prometheus指标端点的用户名。 +# 默认值: "" +metrics-auth-username: "" + +# 字符串。Prometheus指标端点的密码。 +# 默认值: "" +metrics-auth-password: "" +``` diff --git a/docs/locales/zh/mkdocs.yml b/docs/locales/zh/mkdocs.yml index 94f8895ad..b7a237030 100644 --- a/docs/locales/zh/mkdocs.yml +++ b/docs/locales/zh/mkdocs.yml @@ -62,7 +62,7 @@ nav: - "configuration/syslog.md" - "configuration/httpclient.md" - "configuration/advanced.md" - - "configuration/observability.md" + - "configuration/observability_and_metrics.md" - "进阶": - "概述": "advanced/index.md" - "advanced/host-account-domain.md" -- cgit v1.3