diff --git a/next.config.mjs b/next.config.mjs index 0374bdb4..77c436e5 100644 --- a/next.config.mjs +++ b/next.config.mjs @@ -14,6 +14,11 @@ const nextConfig = { destination: '/docs/kagent/supported-providers', permanent: true, }, + { + source: '/docs/kagent/getting-started/tracing', + destination: '/docs/kagent/observability/tracing', + permanent: true, + }, ]; }, webpack: (config) => { diff --git a/public/sitemap.xml b/public/sitemap.xml index 6c954377..64d3b783 100644 --- a/public/sitemap.xml +++ b/public/sitemap.xml @@ -2,756 +2,756 @@ https://kagent.dev/agents - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/blog - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/community - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/concepts/agents - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/concepts/architecture - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/concepts - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/concepts/tools - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/a2a-agents - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/a2a-byo - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/agents-mcp - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/crewai-byo - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/discord-a2a - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/documentation - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/langchain-byo - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/skills - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/examples/slack-a2a - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/first-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/first-mcp-tool - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/local-development - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/getting-started - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/quickstart - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/getting-started/system-prompts - 2026-02-10 - weekly - 0.8 - - - - https://kagent.dev/docs/kagent/getting-started/tracing - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/introduction/installation - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/introduction - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/introduction/what-is-kagent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/observability/audit-prompts - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/observability/launch-ui - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/observability - 2026-02-10 + 2026-02-16 + weekly + 0.8 + + + + https://kagent.dev/docs/kagent/observability/tracing + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/operations/debug - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/operations/operational-considerations - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/operations - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/operations/uninstall - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/operations/upgrade - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/api-ref - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-add-mcp - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-bug-report - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-build - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-completion - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-dashboard - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-deploy - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-get - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-help - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-init - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-install - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-invoke - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-mcp - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-run - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-uninstall - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli/kagent-version - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/cli - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/faq - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/helm - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/resources/release-notes - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/amazon-bedrock - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/anthropic - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/azure-openai - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/byo-openai - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/gemini - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/google-vertexai - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/ollama - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers/openai - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kagent/supported-providers - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/deploy/install-controller - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/deploy - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/deploy/server - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/develop/fastmcp-python - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/develop/mcp-go - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/develop - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/introduction - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/quickstart - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/api-ref - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-add-tool - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-build - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-completion - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-deploy - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-help - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-init - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-install - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-run - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference/kmcp-secrets - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/reference - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs/kmcp/secrets - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/docs - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/enterprise - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/page.tsx - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/argo-rollouts-conversion-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/cilium-crd-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/helm-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/istio-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/k8s-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/kgateway-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/observability-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/agents/promql-agent - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/istio - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/kubernetes - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/prometheus - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/documentation - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/helm - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/argo - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/grafana - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/other - 2026-02-10 + 2026-02-16 weekly 0.8 https://kagent.dev/tools/cilium - 2026-02-10 + 2026-02-16 weekly 0.8 diff --git a/src/app/docs/kagent/getting-started/page.mdx b/src/app/docs/kagent/getting-started/page.mdx index eaa8d382..7ea836ec 100644 --- a/src/app/docs/kagent/getting-started/page.mdx +++ b/src/app/docs/kagent/getting-started/page.mdx @@ -23,6 +23,5 @@ import QuickLink from '@/components/quick-link'; - \ No newline at end of file diff --git a/src/app/docs/kagent/getting-started/tracing/page.mdx b/src/app/docs/kagent/getting-started/tracing/page.mdx deleted file mode 100644 index d06acab2..00000000 --- a/src/app/docs/kagent/getting-started/tracing/page.mdx +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: "Tracing" -pageOrder: 6 -description: "A guide to tracing your kagent agents." ---- - -export const metadata = { - title: "kagent tracing", - description: "A guide to tracing your kagent agents.", - author: "kagent.dev" -}; - -## Prerequisites - -This guide walks you through all the steps you need to get started with tracing your kagent agents, including a basic installation. However, you might want to try out the other getting started guides first to get a better understanding of how kagent works. - -- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) for creating and running a local Kubernetes cluster. -- [Helm](https://helm.sh/docs/intro/install/) for installing the kagent chart. -- [kubectl](https://kubernetes.io/docs/tasks/tools/) for interacting with your cluster. -- kagent CLI for interacting with kagent, such as to launch the dashboard. - - ```bash - # Download/run the install script - curl https://raw.githubusercontent.com/kagent-dev/kagent/refs/heads/main/scripts/get-kagent | bash - ``` - -To run the AI agents you also need an [OpenAI](https://openai.com) API key. You can [get one here](https://platform.openai.com/account/api-keys). - -## Installing Jaeger - -In order to demonstrate tracing, we'll first need to install Jaeger. We will use the Jaeger all in one mode to demonstrate the tracing capabilities without needing to install any other components. - -Create the `jaeger.yaml` file using the following command: - -```yaml -cat << 'EOF' > jaeger.yaml -provisionDataStore: - cassandra: false -allInOne: - enabled: true -storage: - type: memory -agent: - enabled: false -collector: - enabled: false -query: - enabled: false -EOF -``` - -Then install Jaeger using the following command: - -```bash -helm repo add jaegertracing https://jaegertracing.github.io/helm-charts -helm repo update -helm upgrade --install jaeger jaegertracing/jaeger \ - --namespace jaeger \ - --create-namespace \ - --history-max 3 \ - --values jaeger.yaml -``` - -## Installing kagent - -The following steps include commands to install or upgrade the kagent Helm release. - -1. Set the OpenAI API key as an environment variable. - - ```bash - export OPENAI_API_KEY="your-api-key-here" - ``` - -2. If you did not already, install the kagent and kmcp CRDs. - - ```bash - helm upgrade --install kagent-crds oci://ghcr.io/kagent-dev/kagent/helm/kagent-crds \ - --namespace kagent \ - --create-namespace - ``` - -3. If you already installed kagent, get your current Helm release values. - - ```shell - helm get values kagent -n kagent > values.yaml - ``` - -4. Create or update your values file to include the following settings to enable tracing. - - ```yaml - otel: - tracing: - enabled: true - exporter: - otlp: - endpoint: http://jaeger-collector.jaeger.svc.cluster.local:4317 - ``` - -5. Install or upgrade the kagent Helm chart with the tracing details. - - ```bash - helm upgrade -i kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \ - --namespace kagent \ - --set providers.openAI.apiKey=$OPENAI_API_KEY \ - --values values.yaml - ``` - -## Tracing your first agent - -Now that you installed kagent with Jaeger, learn how to trace requests to an agent. - -### Generate tracing data - -To generate tracing data, you can chat with a pre-configured agent such as `k8s-agent`. For more information about agents, see the [Your First Agent](/docs/kagent/getting-started/first-agent) guide. - -1. Launch the kagent dashboard. - - ```bash - kagent dashboard - ``` - - Example output: - - ```console - kagent dashboard is available at http://localhost:8082 - Press Enter to stop the port-forward... - ``` - - ![kagent UI](/images/kagent-landing.png "Kagent dashboard main page") - -2. Click the pre-configured `k8s-agent` agent. - -3. In the conversation box, enter a query such as "What pods are running in my cluster?". - - ![kagent UI](/images/k8s-agent-query-light.png "Chatting with an agent") - -### Review tracing data in Jaeger - -Review the tracing data in Jaeger for the agent queries that you just sent. - -1. In your terminal, enable port-forwarding for the Jaeger query service. - - ```bash - kubectl port-forward svc/jaeger-query -n jaeger 16686:16686 - ``` - -2. In your browser, open the Jaeger UI: [http://localhost:16686](http://localhost:16686). - -3. From the Jaeger **Search** menu, in the **Service** dropdown, select the `kagent` service. - -4. In the **Operation** dropdown, select `agent_run [k8s-agent]` to filter for traces specific to the agent. - -5. Click **Find Traces**. - -6. Review the traces for the `kagent` service. - - ![Jaeger UI](/images/jaeger-landing.png "Jaeger results page") - -7. Click on a trace to see more details. - - ![Jaeger UI](/images/jaeger-trace.png "Jaeger trace details") - -That's it! You've now traced your first agent. - -## Next Steps - -- Learn about [Core Concepts](/docs/kagent/concepts) -- Join our [Community](https://discord.gg/Fu3k65f2k3) - -## Need Help? - -- Visit our [GitHub repository](https://github.com/kagent-dev/kagent) -- Ask a question on [Discord](https://discord.gg/Fu3k65f2k3) -- Check out the [FAQ](/docs/kagent/resources/faq) \ No newline at end of file diff --git a/src/app/docs/kagent/observability/page.mdx b/src/app/docs/kagent/observability/page.mdx index 013c8753..374e7076 100644 --- a/src/app/docs/kagent/observability/page.mdx +++ b/src/app/docs/kagent/observability/page.mdx @@ -21,6 +21,7 @@ import QuickLink from '@/components/quick-link';
+
diff --git a/src/app/docs/kagent/observability/tracing/page.mdx b/src/app/docs/kagent/observability/tracing/page.mdx new file mode 100644 index 00000000..6e557299 --- /dev/null +++ b/src/app/docs/kagent/observability/tracing/page.mdx @@ -0,0 +1,150 @@ +--- +title: "Tracing" +pageOrder: 6 +description: "A guide to tracing your kagent agents." +--- + +export const metadata = { + title: "kagent tracing", + description: "A guide to tracing your kagent agents.", + author: "kagent.dev" +}; + +Set up tracing for your kagent agents. + +## Before you begin + +[Install kagent](/docs/kagent/introduction/installation). + +## Install Jaeger + +Install a tracing tool, such as Jaeger. The following example installs Jaeger in all-in-one mode so that you can try out basic tracing capabilities without needing to install any other components. + +1. Create a `jaeger.yaml` configuration file. + + ```yaml + cat << 'EOF' > jaeger.yaml + provisionDataStore: + cassandra: false + allInOne: + enabled: true + storage: + type: memory + agent: + enabled: false + collector: + enabled: false + query: + enabled: false + EOF + ``` + +2. Install Jaeger. + + ```bash + helm repo add jaegertracing https://jaegertracing.github.io/helm-charts + helm repo update + helm upgrade --install jaeger jaegertracing/jaeger \ + --namespace jaeger \ + --create-namespace \ + --history-max 3 \ + --values jaeger.yaml \ + --version 4.4.7 + ``` + +## Upgrade kagent + +Upgrade your kagent Helm release to enable tracing. + +1. Get your current Helm release values. + + ```shell + helm get values kagent -n kagent > values.yaml + ``` + +2. In the values file, enable tracing with the following settings. + + ```yaml + otel: + tracing: + enabled: true + exporter: + otlp: + endpoint: http://jaeger.jaeger.svc.cluster.local:4317 + ``` + +3. Upgrade the kagent Helm chart with the tracing details. + + ```bash + helm upgrade -i kagent oci://ghcr.io/kagent-dev/kagent/helm/kagent \ + --namespace kagent \ + --values values.yaml + ``` + +## Trace your first agent + +Now that you installed kagent with Jaeger, learn how to trace requests to an agent. + +### Generate tracing data + +To generate tracing data, you can chat with a pre-configured agent such as `k8s-agent`. For more information about agents, see the [Your First Agent](/docs/kagent/getting-started/first-agent) guide. + +1. Launch the kagent dashboard. + + ```bash + kagent dashboard + ``` + + Example output: + + ```console + kagent dashboard is available at http://localhost:8082 + Press Enter to stop the port-forward... + ``` + + ![kagent UI](/images/kagent-landing.png "Kagent dashboard main page") + +2. Click the pre-configured `k8s-agent` agent. + +3. In the conversation box, enter a query such as "What pods are running in my cluster?". + + ![kagent UI](/images/k8s-agent-query-light.png "Chatting with an agent") + +### Review tracing data in Jaeger + +Review the tracing data in Jaeger for the agent queries that you just sent. + +1. In your terminal, enable port-forwarding for the Jaeger service. + + ```bash + kubectl port-forward -n jaeger svc/jaeger 16686:16686 + ``` + +2. In your browser, open the Jaeger UI: [http://localhost:16686](http://localhost:16686). + +3. From the Jaeger **Search** menu, in the **Service** dropdown, select the `kagent` service. + +4. In the **Operation** dropdown, select `agent_run [k8s-agent]` to filter for traces specific to the agent. + +5. Click **Find Traces**. + +6. Review the traces for the `kagent` service. + + ![Jaeger UI](/images/jaeger-landing.png "Jaeger results page") + +7. Click on a trace to see more details. + + ![Jaeger UI](/images/jaeger-trace.png "Jaeger trace details") + +That's it! You've now traced your first agent. + +## Next Steps + +- Learn about [Core Concepts](/docs/kagent/concepts) +- Try out some [Example](/docs/kagent/examples) guides + +## Need Help? + +- Visit our [GitHub repository](https://github.com/kagent-dev/kagent) +- Ask a question on [Discord](https://discord.gg/Fu3k65f2k3) +- Check out the [FAQ](/docs/kagent/resources/faq) \ No newline at end of file diff --git a/src/config/navigation.json b/src/config/navigation.json index 1f1d3c17..98dcb2c6 100644 --- a/src/config/navigation.json +++ b/src/config/navigation.json @@ -61,11 +61,6 @@ "title": "Writing System Prompts", "href": "/docs/kagent/getting-started/system-prompts", "description": "Learn the art and science of writing effective system prompts for your kagent agents." - }, - { - "title": "Tracing", - "href": "/docs/kagent/getting-started/tracing", - "description": "A guide to tracing your kagent agents." } ] }, @@ -204,6 +199,11 @@ "title": "Audit kagent prompts", "href": "/docs/kagent/observability/audit-prompts", "description": "Review and audit prompts used by kagent agents." + }, + { + "title": "Tracing", + "href": "/docs/kagent/observability/tracing", + "description": "A guide to tracing your kagent agents." } ] },