docs: add Axiom observability guides - #989
Merged
Merged
Conversation
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
28 tasks
Deploying agentproxy with
|
| Latest commit: |
22979fb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://11792275.agentproxy.pages.dev |
| Branch Preview URL: | https://axiom-kubernetes-observabili.agentproxy.pages.dev |
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
danehans
changed the title
Applies the docs review of #989. The technical content was already correct and validates against the v1.5.0-beta CRD schemas and the standalone config schema; these edits cover house conventions and copy. - Note that agentgateway resolves ${...} in the config file from its own environment at startup and exits if a variable is unset, so the standalone guide no longer strands the reader in a second terminal. - Use the namespace, api-version, backend, and policy reuse snippets instead of hardcoding agentgateway-system and the resource kinds. - Replace the port-forward-only step with the agw-get-gateway-url-k8s snippet, so the guide covers LoadBalancer and local access. - Add field tables under the configuration examples, limited to fields that appear in the example above them. - Indent the API token screenshot into its step, so the procedure stays one ordered list. - Complete the standalone cleanup: collector config file, frontendPolicies sections, and the exported variables. - Use ${env:...} in the collector headers, and explain which variables the shell substitutes and which reach the collector unchanged. - Normalize "logs" to "access logs", spell out OTLP on first use, and tighten wording throughout. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
The latest and main copies of each Axiom page were byte-identical, so an edit had to be made in four files instead of two. Follows the pattern that STYLE_GUIDE.md documents and that integrations/llm-clients already uses: the body lives under assets/agw-docs/pages/, and each content file is front matter plus one reuse call. Directory naming follows llm-clients-k8s and llm-clients, where the -k8s suffix marks the Kubernetes-only body. The rendered article is word-for-word and element-for-element identical before and after on all four pages; only whitespace moves, which is the reuse shortcode flattening its output. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Each mode has its own asset root, and the body belongs under the root for
the mode it documents:
- Kubernetes -> assets/agw-docs/pages/agentgateway/llm/axiom.md, beside
the existing llm/observability.md and llm/tracing.md
- Standalone -> assets/agw-docs/standalone/llm/axiom.md, in a new llm
directory alongside quickstart, setup, and operations
Replaces the integrations/llm-observability{,-k8s} pair from the previous
commit, which mirrored the content path and put a standalone body under
the Kubernetes asset root.
The rendered article is word-for-word and element-for-element identical on
all four pages.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
kristin-kronstain-brown
approved these changes
Sep 3, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Company
Not applicable; this pull request updates documentation.
Contribution summary
Checklist
Logo file
Listing
documentation.
Preview
The integration was manually verified end to end. Agentgateway and OpenTelemetry Collector configuration validation passed, and the full Hugo build completed successfully.