Skip to content

usage.md

Latest commit

 

History

History
746 lines (432 loc) · 39.7 KB

usage.md

File metadata and controls

746 lines (432 loc) · 39.7 KB

Command-Line Help for weaver

This document contains the help content for the weaver command-line program.

Command Overview:

weaver

Manage semantic convention registry and telemetry schema workflows (OpenTelemetry Project)

Usage: weaver [OPTIONS] <COMMAND>

Subcommands:
  • registry — Manage Semantic Convention Registry
  • diagnostic — Manage Diagnostic Messages
  • completion — Generate shell completions
  • serve — Start the API server (Experimental)
Options:
  • --debug — Turn debugging information on. Use twice (--debug --debug) for trace-level logs
  • --quiet — Turn the quiet mode on (i.e., minimal output)
  • --future — Enable the most recent validation rules for the semconv registry. It is recommended to enable this flag when checking a new registry. Note: semantic_conventions main branch should always enable this flag
  • --allow-git-credentials — Allow git credential helpers when cloning registries from private repositories. By default, git operations are isolated and cannot access global git config or credential helpers. Enable this flag to authenticate with private registries using your system's configured git credential helpers (e.g., osxkeychain, git-credential-manager)
  • --config <CONFIG> — Path to a .weaver.toml project config file. When set, skips the upward-walk discovery from the current working directory

weaver registry

Manage Semantic Convention Registry

Usage: weaver registry <COMMAND>

Subcommands:
  • check — Validates a semantic convention registry.
  • generate — Generates artifacts from a semantic convention registry.
  • resolve — DEPRECATED - Resolves a semantic convention registry. This command is deprecated and will be removed in a future version. Please use 'weaver registry generate' or 'weaver registry package' instead.
  • search — DEPRECATED - Searches a registry. This command is deprecated and will be removed in a future version. It is not compatible with V2 schema. Please search the generated documentation instead
  • stats — Calculate a set of general statistics on a semantic convention registry
  • update-markdown — Update markdown files that contain markers indicating the templates used to update the specified sections
  • json-schema — Generate the JSON Schema of the resolved registry documents consumed by the template generator and the policy engine.
  • diff — Generate a diff between two versions of a semantic convention registry.
  • emit — Emits a semantic convention registry as example signals to your OTLP receiver.
  • live-check — Perform a live check on sample telemetry by comparing it to a semantic convention registry.
  • mcp — Run an MCP (Model Context Protocol) server for the semantic convention registry.
  • infer — Generates a schema file by inferring the schema from a OTLP message.
  • package — Packages a semantic convention registry into a self-contained artifact.

weaver registry check

Validates a semantic convention registry.

The validation process for a semantic convention registry involves several steps:

  • Loading the semantic convention specifications from a local directory or a git repository.
  • Parsing the loaded semantic convention specifications.
  • Resolving references and extends clauses within the specifications.
  • Checking compliance with specified Rego policies, if provided.

Note: The -d and --registry-git-sub-dir options are only used when the registry is a Git URL otherwise these options are ignored.

The process exits with a code of 0 if the registry validation is successful.

Usage: weaver registry check [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --baseline-registry <BASELINE_REGISTRY> — Parameters to specify the baseline semantic convention registry

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry generate

Generates artifacts from a semantic convention registry.

Rego policies present in the registry or specified using -p or --policy will be automatically validated by the policy engine before the artifact generation phase.

Note: The -d and --registry-git-sub-dir options are only used when the registry is a Git URL otherwise these options are ignored.

The process exits with a code of 0 if the generation is successful.

Usage: weaver registry generate [OPTIONS] [TARGET] [OUTPUT]

Arguments:
  • <TARGET> — Target to generate the artifacts for
  • <OUTPUT> — Path to the directory where the generated artifacts will be saved. Default is the output directory
Options:

  • -t, --templates <TEMPLATES> — Path to the directory where the templates are located. Default is the templates directory. [default: templates]

  • -c, --config <CONFIG> — List of weaver.yaml configuration files to use. When there is a conflict, the last one will override the previous ones for the keys that are defined in both

  • -D, --param <PARAM> — Parameters key=value, defined in the command line, to pass to the templates. The value must be a valid YAML value

  • --params <PARAMS> — Parameters, defined in a YAML file, to pass to the templates

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --future — Enable the most recent validation rules for the semconv registry. It is recommended to enable this flag when checking a new registry

    Default value: false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry resolve

DEPRECATED - Resolves a semantic convention registry. This command is deprecated and will be removed in a future version. Please use 'weaver registry generate' or 'weaver registry package' instead.

Usage: weaver registry resolve [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --lineage — Flag to indicate if lineage information should be included in the resolved schema (not yet implemented)

    Default value: false

  • -o, --output <OUTPUT> — Output file to write the resolved schema to If not specified, the resolved schema is printed to stdout

  • -f, --format <FORMAT> — Output format for the resolved schema Supported formats: yaml, json, jsonl, mute Default format: yaml Example: --format json

    Default value: yaml

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry search

DEPRECATED - Searches a registry. This command is deprecated and will be removed in a future version. It is not compatible with V2 schema. Please search the generated documentation instead

Usage: weaver registry search [OPTIONS] [SEARCH_STRING]

Arguments:
  • <SEARCH_STRING> — An (optional) search string to use. If specified, will return matching values on the command line. Otherwise, runs an interactive terminal UI
Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --lineage — Flag to indicate if lineage information should be included in the resolved schema (not yet implemented)

    Default value: false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry stats

Calculate a set of general statistics on a semantic convention registry

Usage: weaver registry stats [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --format <FORMAT> — Output format for the stats. Predefined formats are: text, json, yaml, jsonl, mute. [default: text]

  • --templates <TEMPLATES> — Path to the directory where the stats templates are located. [default: stats_templates]

  • -o, --output <OUTPUT> — Path to the directory where the generated artifacts will be saved. If not specified, the stats are printed to stdout

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry update-markdown

Update markdown files that contain markers indicating the templates used to update the specified sections

Usage: weaver registry update-markdown [OPTIONS] [MARKDOWN_DIR]

Arguments:
  • <MARKDOWN_DIR> — Path to the directory where the markdown files are located
Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --dry-run <DRY_RUN> — Whether or not to run updates in dry-run mode. [default: false]

    Possible values: true, false

  • --attribute-registry-base-url <ATTRIBUTE_REGISTRY_BASE_URL> — Optional path to the attribute registry. If provided, all attributes will be linked here

  • -D, --param <PARAM> — Parameters key=value, defined in the command line, to pass to the templates. The value must be a valid YAML value

  • --params <PARAMS> — Parameters, defined in a YAML file, to pass to the templates

  • -t, --templates <TEMPLATES> — Path to the directory where the templates are located. Note: registry update-markdown will look for a specific jinja template: {templates}/{target}/snippet.md.j2. [default: templates]

  • --target <TARGET> — The target to generate snippets with. Note: registry update-markdown will look for a specific jinja template: {templates}/{target}/snippet.md.j2

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry json-schema

Generate the JSON Schema of the resolved registry documents consumed by the template generator and the policy engine.

The produced JSON Schema can be used to generate documentation of the resolved registry format or to generate code in your language of choice if you need to interact with the resolved registry format for any reason.

Usage: weaver registry json-schema [OPTIONS]

Options:

  • -j, --json-schema <JSON_SCHEMA> — The type of JSON schema to generate

    Default value: resolved-registry

    Possible values:

    • resolved-registry: The JSON schema of a resolved registry
    • semconv-group: The JSON schema of a semantic convention group
    • semconv-definition-v2: The JSON schema of the V2 definition
    • resolved-registry-v2: The JSON schema of the V2 resolved registry
    • materialized-registry-v2: The JSON schema we send to Rego / Jinja
    • diff: The JSON schema of the diff
    • diff-v2: The JSON schema of the diff V2
    • publication-manifest-v2: The JSON schema of the publication manifest produced by weaver registry package
    • definition-manifest-v2: Definition manifest describing unpublished registry
    • policy-finding: The JSON schema of a policy finding returned by Rego policies
    • weaver-config: The JSON schema of the .weaver.toml configuration file

  • -o, --output <OUTPUT> — Output file to write the JSON schema to If not specified, the JSON schema is printed to stdout

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry diff

Generate a diff between two versions of a semantic convention registry.

This diff can then be rendered in multiple formats:

  • a console-friendly format (default: ansi),
  • a structured document in JSON format,
  • ...

Usage: weaver registry diff [OPTIONS] --baseline-registry <BASELINE_REGISTRY>

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --baseline-registry <BASELINE_REGISTRY> — Parameters to specify the baseline semantic convention registry

  • --format <FORMAT> — Format used to render the schema changes. Predefined formats are: ansi, json, and markdown. [default: ansi]

  • --templates <TEMPLATES> — Path to the directory where the schema changes templates are located. [default: diff_templates]

  • -o, --output <OUTPUT> — Path to the directory where the generated artifacts will be saved. If not specified, the diff report is printed to stdout

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver registry emit

Emits a semantic convention registry as example signals to your OTLP receiver.

This uses the standard OpenTelemetry SDK, defaulting to OTLP gRPC on localhost:4317.

Usage: weaver registry emit [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

  • --stdout <STDOUT> — Write the telemetry to standard output [default: false]

    Possible values: true, false

  • --endpoint <ENDPOINT> — Endpoint for the OTLP receiver. OTEL_EXPORTER_OTLP_ENDPOINT env var will override this. [default: http://localhost:4317]

weaver registry live-check

Perform a live check on sample telemetry by comparing it to a semantic convention registry.

Includes: Flexible input ingestion, configurable assessment, and template-based output.

Usage: weaver registry live-check [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

  • --input-source <INPUT_SOURCE> — Where to read the input telemetry from. {file path} | stdin | otlp [default: otlp]

  • --input-format <INPUT_FORMAT> — The format of the input telemetry. text | json (not required for OTLP) [default: json]

  • --format <FORMAT> — Format used to render the report. Builtin formats: json, yaml, jsonl. Other values are template names (e.g. "ansi"). [default: ansi]

  • --templates <TEMPLATES> — Path to the directory where the templates are located. [default: live_check_templates]

  • --no-stream <NO_STREAM> — Disable stream mode (build report before rendering). [default: false]

    Possible values: true, false

  • --no-stats <NO_STATS> — Disable statistics accumulation. Useful for long-running sessions. [default: false]

    Possible values: true, false

  • -o, --output <OUTPUT> — Path to save generated artifacts. Use "none" to suppress output, "http" to send as the /stop response

  • --otlp-grpc-address <OTLP_GRPC_ADDRESS> — Address used by the gRPC OTLP listener

  • --otlp-grpc-port <OTLP_GRPC_PORT> — Port used by the gRPC OTLP listener

  • --emit-otlp-logs <EMIT_OTLP_LOGS> — Enable OTLP log emission for live check policy findings

    Possible values: true, false

  • --otlp-logs-endpoint <OTLP_LOGS_ENDPOINT> — OTLP endpoint for log emission

  • --otlp-logs-stdout <OTLP_LOGS_STDOUT> — Use stdout for OTLP log emission (debug mode)

    Possible values: true, false

  • --admin-port <ADMIN_PORT> — Port used by the HTTP admin port (endpoints: /stop)

  • --inactivity-timeout <INACTIVITY_TIMEOUT> — Max inactivity time in seconds before stopping the listener

  • --advice-policies <ADVICE_POLICIES> — Advice policies directory. Set this to override the default policies

  • --advice-preprocessor <ADVICE_PREPROCESSOR> — Advice preprocessor. A jq script to preprocess the registry data before passing to rego

weaver registry mcp

Run an MCP (Model Context Protocol) server for the semantic convention registry.

This server exposes the registry to LLMs, enabling natural language queries for finding and understanding semantic conventions while writing instrumentation code.

The server communicates over stdio using JSON-RPC.

Usage: weaver registry mcp [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

  • --advice-policies <ADVICE_POLICIES> — Advice policies directory. Set this to override the default policies

  • --advice-preprocessor <ADVICE_PREPROCESSOR> — Advice preprocessor. A jq script to preprocess the registry data before passing to rego

  • --namespace-separator <NAMESPACE_SEPARATOR> — Namespace separator used in attribute keys. Defaults to ".". Used by namespace browsing and search token splitting. [default: .]

weaver registry infer

Generates a schema file by inferring the schema from a OTLP message.

Usage: weaver registry infer [OPTIONS]

Options:

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

  • -o, --output <OUTPUT> — Output folder for generated YAML files. [default: ./inferred-registry/]

  • --grpc-address <GRPC_ADDRESS> — Address used by the gRPC OTLP listener. [default: 0.0.0.0]

  • --grpc-port <GRPC_PORT> — Port used by the gRPC OTLP listener. [default: 4317]

  • --admin-port <ADMIN_PORT> — Port used by the HTTP admin server (endpoints: /stop). [default: 8080]

  • --inactivity-timeout <INACTIVITY_TIMEOUT> — Seconds of inactivity before auto-stop (0 = never). [default: 60]

weaver registry package

Packages a semantic convention registry into a self-contained artifact.

Usage: weaver registry package [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • -o, --output <OUTPUT> — Path to the directory where the package will be written. [default: output]

  • --resolved-schema-uri <RESOLVED_SCHEMA_URI> — URI where the resolved schema will eventually be published. This value is embedded in the publication manifest as resolved_schema_uri

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver diagnostic

Manage Diagnostic Messages

Usage: weaver diagnostic <COMMAND>

Subcommands:
  • init — Initializes a diagnostic_templates directory to define or override diagnostic output formats

weaver diagnostic init

Initializes a diagnostic_templates directory to define or override diagnostic output formats

Usage: weaver diagnostic init [OPTIONS] [TARGET]

Arguments:

  • <TARGET> — Optional target to initialize the diagnostic templates for. If empty, all default templates will be extracted

    Default value: ``

Options:

  • -t, --diagnostic-templates-dir <DIAGNOSTIC_TEMPLATES_DIR> — Optional path where the diagnostic templates directory should be created

    Default value: diagnostic_templates

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

weaver completion

Generate shell completions

Usage: weaver completion <SHELL>

Arguments:

  • <SHELL> — The shell to generate the completions for

    Possible values: bash, elvish, fish, powershell, zsh

weaver serve

Start the API server (Experimental)

Usage: weaver serve [OPTIONS]

Options:

  • -r, --registry <REGISTRY> — Local folder, Git repo URL, or Git archive URL of the semantic convention registry. For Git URLs, a reference can be specified using the @refspec syntax and a sub-folder can be specified using the [sub-folder] syntax after the URL. [default: https://github.com/open-telemetry/semantic-conventions.git[model]]

  • -s, --follow-symlinks <FOLLOW_SYMLINKS> — Boolean flag to specify whether to follow symlinks when loading the registry. [default: false]

    Possible values: true, false

  • --include-unreferenced <INCLUDE_UNREFERENCED> — Boolean flag to include signals and attributes defined in dependency registries, even if they are not explicitly referenced in the current (custom) registry. [default: false]

    Possible values: true, false

  • --v2 <V2> — Whether or not to output version 2 of the schema. Note: this will impact both output to templates and policies. [default: false]

    Possible values: true, false

  • -p, --policy <POLICIES> — Optional list of policy files or directories to check against the files of the semantic convention registry. If a directory is provided all .rego files in the directory will be loaded

  • --skip-policies <SKIP_POLICIES> — Skip the policy checks. [default: false]

    Possible values: true, false

  • --display-policy-coverage <DISPLAY_POLICY_COVERAGE> — Display the policy coverage report (useful for debugging). [default: false]

    Possible values: true, false

  • --bind <BIND> — Address to bind the server to. [default: 127.0.0.1:8080]

  • --cors-origins <CORS_ORIGINS> — Allowed CORS origins (comma-separated). Use '*' for any origin. If not specified, CORS is disabled (same-origin only)

  • --diagnostic-format <DIAGNOSTIC_FORMAT> — Format used to render the diagnostic messages. Predefined formats are: ansi, json, gh_workflow_command. [default: ansi]

  • --diagnostic-template <DIAGNOSTIC_TEMPLATE> — Path to the directory where the diagnostic templates are located. [default: diagnostic_templates]

  • --diagnostic-stdout <DIAGNOSTIC_STDOUT> — Send the output to stdout instead of stderr. [default: false]

    Possible values: true, false

This document was generated automatically by clap-markdown.