Skip to main content
Use a coding assistant to add instrumentation to your application using the guide for its language or framework. The assistant can identify the entry points, install the appropriate SDK, and configure telemetry export. Automatic instrumentation captures supported libraries and frameworks. Depending on your language and application, you may still need code changes or custom spans to capture business operations. Review the generated changes before deploying them.

​
Before you begin

You need your application source code, a coding assistant with access to the repository, and a ClickHouse Observability destination. Choose the appropriate language SDK guide for your application; it provides the SDK packages, supported signals, and exporter settings to use.

​
Configure your destination

Open Team Settings → Data → Managed Telemetry and copy your OTLP HTTP endpoint and ingestion API key. Store them in an environment file excluded from version control or in your secrets store.If your service displays the Getting Started page, you can instead select Copy prompt under Instrument with AI. Copy the prompt from Set it up with an AI agent, and set the CLICKSTACK_OTLP_ENDPOINT and CLICKSTACK_API_KEY variables shown in that dialog. Follow the remaining review and verification steps below.

​
Give your assistant the language guide

Open your application repository in your coding assistant, such as Claude Code, Cursor, or Codex. Copy the following prompt, replacing the placeholders with your language guide URL, deployment type, and service name. Supply the names of your environment variables rather than pasting credentials into the prompt.
The variable names in this prompt identify where your connection values are stored. They do not replace the SDK’s required variables: the assistant must map them to the settings documented in your language guide. For browser applications, use the Browser SDK guide, including its browser-specific endpoint and key configuration.

​
Review and run the application

Review the dependency, initialization, and startup changes. Check that the assistant selected the correct destination and authentication format, preserved existing instrumentation, and kept secrets out of committed files. Run your application’s existing tests, then start it with the updated command and environment. Make a request or perform an action that exercises an instrumented library. If you need telemetry for an operation that automatic instrumentation does not capture, ask the assistant to add a custom span using your SDK’s API.

​
Verify telemetry

  1. Open Search in ClickHouse Observability.
  2. Select the appropriate logs or traces source and a time range covering your test activity.
  3. Filter for your service name and inspect the generated events. Check that the expected request or operation appears.
  4. If the SDK exports metrics, use Chart Explorer to inspect them.
A successful application startup does not confirm telemetry delivery. If events are missing, check the application’s exporter errors, endpoint, protocol, and authentication settings. For self-managed deployments, also inspect the collector logs. For a complete application example, follow the HackerNews Analyzer demo.