Feat(ai-gateway): v2 telemetry#5674
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Updates Kong AI Gateway v2 telemetry documentation by shifting OpenTelemetry span/metric references to policy-based, data-driven includes, and introducing an AI Gateway–specific logs reference page.
Changes:
- Updated AI Gateway OpenTelemetry span attribute and metric reference pages to use new v2 includes and ai-gateway versioning.
- Added new reusable include/data sources for v2 OpenTelemetry span attributes and metrics tables.
- Added a new
/ai-gateway/ai-logs/reference page and updated cross-links from existing AI Gateway docs.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| app/ai-gateway/semantic-similarity.md | Points troubleshooting guidance to the new AI Gateway logs page. |
| app/ai-gateway/llm-open-telemetry.md | Updates frontmatter/versioning and switches span attribute tables to v2 include. |
| app/ai-gateway/ai-otel-metrics.md | Updates frontmatter/versioning and switches metric tables to v2 include. |
| app/ai-gateway/ai-logs.md | Adds a new AI Gateway logs reference page (needs metadata/table fixes). |
| app/ai-gateway/ai-audit-log-reference.md | Updates references to AI Gateway logs and v2 positioning (needs anchor/wording fixes). |
| app/_includes/md/ai-gateway/v2/policies/span_attribute_tables.md | New include to render span attribute reference tables from v2 data. |
| app/_includes/md/ai-gateway/v2/policies/metric_tables.md | New include to render metric reference tables (with prefix filtering) from v2 data. |
| app/_includes/md/ai-gateway/v2/policies/collecting-otel-data.md | New include with OTLP backend setup guidance for AI Gateway v2. |
| app/_data/plugins/otel-metrics.yaml | Changes min_version for metrics used by OTEL plugin docs (versioning appears incorrect). |
| app/_data/ai-gateway/v2/otel-span-attributes.yaml | New v2 span attribute data source for AI Gateway OTel docs. |
| app/_data/ai-gateway/v2/otel-metrics.yaml | New v2 metrics data source for AI Gateway OTel docs. |
| - setting: "`config.logging.log_statistics`: `true`" | ||
| plugin: "[AI Proxy](/plugins/ai-proxy/reference/) or [AI Proxy Advanced](/plugins/ai-proxy-advanced/reference/)" | ||
| policy: "[AI Proxy](/plugins/ai-proxy/reference/) or [AI Proxy Advanced](/plugins/ai-proxy-advanced/reference/)" | ||
| required_for: "[Gen AI metrics](#gen-ai-metrics-otel-semantic-conventions)" |
| --- | ||
|
|
||
| {{site.ai_gateway}} emits structured analytics logs for [AI plugins](/plugins/?category=ai) through the standard [{{site.base_gateway}} logging infrastructure](/gateway/logs/). This means AI-specific logs are written to [the same locations](/gateway/logs/#where-are-kong-gateway-logs-located) as other Kong logs, such as `/usr/local/kong/logs/error.log`, or to Docker container logs if you're running in a containerized environment. | ||
| {{site.ai_gateway}} emits structured analytics logs for [AI plugins](/plugins/?category=ai) following the same patterns as {{site.base_gateway}}. This means {{site.ai_gateway}} logs are written to [the same locations](/ai-gateway/ai-logs/#where-are-kong-gateway-logs-located) as other Kong logs, such as `/usr/local/kong/logs/error.log`, or to Docker container logs if you're running in a containerized environment. |
| Like other Kong logs, {{site.ai_gateway}} logs are subject to the [global log level](/gateway/logs/#configure-log-levels) configured via the [`kong.conf`](/gateway/configuration/) file or the Admin API. You can control log verbosity by adjusting the `log_level` setting (for example, `info`, `notice`, `warn`, `error`, `crit`) to determine which log entries are captured. | ||
| You can set the [global log level](/ai-gateway/ai-logs/#configure-log-levels) for {{site.ai_gateway}} via the [`kong.conf`](/gateway/configuration/) file or the Admin API. You can control log verbosity by adjusting the `log_level` setting (for example, `info`, `notice`, `warn`, `error`, `crit`) to determine which log entries are captured. | ||
|
|
||
| When operating {{site.ai_gateway}} alongside {{site.base_gateway}}, logs are stored separately in each products run time environment. |
lmilan
left a comment
There was a problem hiding this comment.
Left some comments and suggestions, also app/_config/releases/ai-gateway/v1.yml was not updated, is that expected?
| --- | ||
|
|
||
| {{site.ai_gateway}} emits structured analytics logs for [AI plugins](/plugins/?category=ai) through the standard [{{site.base_gateway}} logging infrastructure](/gateway/logs/). This means AI-specific logs are written to [the same locations](/gateway/logs/#where-are-kong-gateway-logs-located) as other Kong logs, such as `/usr/local/kong/logs/error.log`, or to Docker container logs if you're running in a containerized environment. | ||
| {{site.ai_gateway}} emits structured analytics logs for [AI Policies](/plugins/?category=ai) following the same patterns as {{site.base_gateway}}. This means {{site.ai_gateway}} logs are written to [the same locations](/ai-gateway/ai-logs/#where-are-kong-gateway-logs-located) as other Kong logs, such as `/usr/local/kong/logs/error.log`, or to Docker container logs if you're running in a containerized environment. |
There was a problem hiding this comment.
Does this apply to Konnect?
There was a problem hiding this comment.
I think this does apply in the hybrid situation you get from e.g. the quickstart script with a Konnect CP and local dockerised DP
Co-authored-by: Lucie Milan <32450552+lmilan@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Description
Fixes #issue
Preview Links
https://deploy-preview-5674--kongdeveloper.netlify.app/ai-gateway/ai-audit-log-reference/
Checklist
descriptionentry in frontmatter.