[docs] Add documentation for OpenTelemetry#1577
[docs] Add documentation for OpenTelemetry#1577andrewnicols wants to merge 1 commit intomoodle:mainfrom
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds a new developer documentation page describing Moodle’s Open Telemetry support (since 5.2) and updates the project cspell dictionary for new telemetry-related terms.
Changes:
- Add a new
docs/apis/telemetry/index.mdxpage covering installation, configuration, and extending instrumentation. - Add new cspell exceptions for telemetry backend names in
project-words.txt.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
docs/apis/telemetry/index.mdx |
Introduces an Open Telemetry API guide (since 5.2), including setup and extension guidance. |
project-words.txt |
Adds spellcheck exceptions for newly introduced telemetry-related proper nouns. |
| In order to install the Moodle Open Telemetry integration, several prerequisites are required, including: | ||
|
|
There was a problem hiding this comment.
The sentence "In order to install ..., several prerequisites are required, including:" is a fragment and is immediately followed by a new paragraph. Consider either removing this line, or following it with the actual prerequisite list (and then the composer installation step).
| In order to install the Moodle Open Telemetry integration, several prerequisites are required, including: |
| - An Open Telemetry Transport, such as HTTP (included) or [open-telemetry/transport-grpc](https://packagist.org/packages/open-telemetry/transport-grpc) | ||
| - An Open Telemetry Exporter, such as [open-telemetry/exporter-otlp](https://packagist.org/packages/open-telemetry/exporter-otlp) | ||
| - An Open Telemetry Collector, which is responsible for receiving telemetry data from Moodle and forwarding it to the telemetry backend. The Open Telemetry Collector can be deployed as a standalone service or as part of a larger monitoring infrastructure. | ||
| - A telemetry backend that supports the Open Telemetry protocol, such as [Signoz](https://signoz.io/), [Jaeger](https://www.jaegertracing.io/), [Zipkin](https://zipkin.io/), or [Prometheus](https://prometheus.io/), to receive and analyze the telemetry data collected from Moodle. |
There was a problem hiding this comment.
The backend name is typically stylized as "SigNoz" (matching the project's branding). Consider updating the link text accordingly to avoid a typo/branding mismatch.
| - A telemetry backend that supports the Open Telemetry protocol, such as [Signoz](https://signoz.io/), [Jaeger](https://www.jaegertracing.io/), [Zipkin](https://zipkin.io/), or [Prometheus](https://prometheus.io/), to receive and analyze the telemetry data collected from Moodle. | |
| - A telemetry backend that supports the Open Telemetry protocol, such as [SigNoz](https://signoz.io/), [Jaeger](https://www.jaegertracing.io/), [Zipkin](https://zipkin.io/), or [Prometheus](https://prometheus.io/), to receive and analyze the telemetry data collected from Moodle. |
| Recaptcha | ||
| RDBM | ||
| RDBMS | ||
| Signoz |
There was a problem hiding this comment.
If you update the docs to use the correct "SigNoz" spelling, please update the cspell exception here to match (and remove the misspelled entry) so spellchecking stays aligned with the docs content.
| Signoz | |
| SigNoz |
| OTEL_PHP_DISABLED_INSTRUMENTATIONS=moodlelms | ||
| ``` | ||
|
|
||
| This will disable the Moodle Open Telemetry extension, whilst allowing other Open Telemetry integrations to continue collecting telemetry data and sending it to the telemetry backend. |
There was a problem hiding this comment.
This paragraph refers to disabling the "Moodle Open Telemetry extension", but earlier the page describes an integration/package and the upstream PHP extension separately. Consider adjusting the wording here to consistently refer to the Moodle integration/instrumentation to avoid confusion about what is being disabled.
| This will disable the Moodle Open Telemetry extension, whilst allowing other Open Telemetry integrations to continue collecting telemetry data and sending it to the telemetry backend. | |
| This will disable the Moodle Open Telemetry integration, whilst allowing other Open Telemetry integrations to continue collecting telemetry data and sending it to the telemetry backend. |
|
|
||
| ### Moodle-specific instrumentation | ||
|
|
||
| To create your own page, you should: |
There was a problem hiding this comment.
"To create your own page" seems out of place in the "Moodle-specific instrumentation" section. Consider rephrasing to refer to creating your own instrumentation package/hook (since the following bullets describe package type/listeners), not a page.
| To create your own page, you should: | |
| To create your own Moodle-specific instrumentation package, you should: |
| Moodle added support for Open Telemetry in version 5.2. This allows Moodle to collect telemetry data and send it to a telemetry backend for analysis and monitoring. | ||
|
|
||
| The Moodle Open Telemetry integration sits outside of Moodle core and follows the same pattern as other Open Telemetry integrations for PHP. | ||
|
|
||
| ## Installation |
There was a problem hiding this comment.
This new API guide isn’t referenced from the main API landing page (docs/apis.md), which currently contains a curated list of APIs and has no mention of telemetry. Consider adding an entry there so the new page is discoverable from the primary API index.
| --- | ||
| title: Open Telemetry | ||
| tags: | ||
| - telemetry |
There was a problem hiding this comment.
Frontmatter tags list indentation is inconsistent with other docs pages (typically either unindented - or 2-space indented). For consistency/readability, align this to the established style (e.g., see docs/apis/core/hooks/index.md:3-7 or docs/apis/plugintypes/antivirus/index.mdx:3-7).
| - telemetry | |
| - telemetry |
No description provided.