Skip to main content
Version: 6.2

AI Observability Module Installation

The AI Observability module is delivered as three complementary components.


Delivery Composition​

ComponentPurpose
Content moduleDashboards, scheduled jobs, runtime indexes, tags, and ISM policies
Installation utilityDeploys ingest pipelines, index templates and patterns, gen_ai_* write indexes, lookups, the ai command preset, the GPU inventory asset, and health metrics
Data collection configurationsConfigurations for LLM Gateway, Inference, Claude Code, Codex, and GPU, plus the Claude Code subscription-limit collector

Installation Steps​

  1. Installing the utility - deploy objects not included in the content module: ingest pipelines, index templates and patterns, gen_ai_* write indexes, lookups, the ai command preset, the GPU inventory asset, and health metrics
  2. Installing the content module - import ai_observability.zip (dashboards, jobs, indexes, ISM policies, and tags)
  3. Bind retention policies - rerun the utility with --bind-ism-policies after importing the content module
  4. Setting up data collection - deploy the data collection configurations and set up telemetry routes

The utility runs before the content module is imported because module jobs and dashboards refer to templates, patterns, lookups, and a preset that the content module does not include. Retention policies, however, are included in the content module, so the utility binds them to write indexes on a second run after import.

When updating from 6.1, run the utility again after import with --remove-legacy-dashboards: this removes the version 6.1 dashboard that is not included in 6.2. The --bind-ism-policies and --remove-legacy-dashboards flags are mutually exclusive and require separate runs.


Post-installation Actions​

ActionWhen
Import rows into claude_code_members from the organization member export in the Claude console; without them, member dashboards and incidents lack member names and seat typesafter a new installation
Adjust seat prices in claude_code_seat_pricing to match the contract; the utility writes Team plan prices only to an empty lookupif the contract differs from Team plan prices
Set the model in the ai_observability_default preset if its name differs on this installationif the model name differs
Replace HOST:PORT in ai_observability_api_* job requests and add the keystore key before enabling them (Jobs)if the jobs are needed
Wait for analytics to accumulate: lookup jobs recalculate the last two days, and earlier telemetry is not added to analytics (Jobs)after a new installation
Reapply manual changes to Service Monitor Toolkit metrics and their permissions; rerunning the utility overwrites the supplied metricsafter each utility run
Run the utility with --bind-ism-policies; without it, retention policies are not bound to write indexes and rollover does not workafter each content-module import
Migrate data from gen_ai_* indexes used by version 6.1 collection using the commands printed by the utilitywhen updating from 6.1
Run the utility with --remove-legacy-dashboards; the update does not remove the AI Observability: Claude Code dashboard, and the UI does not remove it eitherwhen updating from 6.1
Delete copies of module dashboards that were edited in the UI; while such a copy exists, it opens instead of the updated dashboardwhen updating from 6.1