Owl CLI Tool Inventory¶

This document introduces the business tool capabilities that can be directly executed by the Owl CLI, including tool scope, permission types, CLI usage conventions, tool overview, and tool descriptions categorized by type.

The visibility and execution results of tools depend on the permissions of the API Key corresponding to the current OWL_TOKEN. If the API Key lacks the necessary resource or operation permissions, the corresponding tool may fail to execute or return empty results.

Tool Scope¶

The tools exposed by Owl CLI will be continuously updated along with platform capabilities. The actual visible tools are subject to the tool directory returned by owl list after completing owl sync locally.

The current document covers the following business categories:

Permission Types¶

CLI Usage Conventions¶

Common CLI Command Examples:

owl sync
owl list
owl list -c data
owl show owl.data.query
owl exec owl.metric.list --mode source
owl exec owl.event.list --start_time 1712505600000 --end_time 1712592000000 --limit 20

Tool Overview¶

Catalog¶

Used for entity type discovery, entity query, entity detail retrieval, and topology relationship query in the unified resource catalog.

Dashboard¶

Used for dashboard creation, replacement, and detail retrieval.

Data¶

Used for full data query and query assistance, covering data domains such as Log, Metrics, RUM, APM, Network, Profile, Billing, etc.

Errors¶

Used for error center issue list query, and comment addition, query, and update.

Event¶

Used for event center list query and event detail retrieval.

Incident¶

Used for incident list, incident comments, operation records, and on-call schedule query.

Infrastructure¶

Used for infrastructure object list and detail query, covering resource objects such as hosts, containers, processes, etc.

LLM¶

Used for LLM observable application list query.

Member¶

Used for workspace member list query and retrieval by name or email keyword.

Monitor¶

Used for monitor list query, detail retrieval, creation or update, and external event reception.

Pipeline¶

Used for Pipeline list query and sample validation.

CLI Usage Paths¶

Data Query Problems¶

Applicable to problems like "querying Metrics, Log, RUM, APM, Network, Profile, Billing data".

1. First execute owl.data.show_dql_namespace to confirm the target namespace.

2. Call discovery tools by data domain:

   • Metrics: owl.metric.list
   • RUM: owl.rum.list
   • APM: owl.apm.list
   • Network: owl.network.list
   • Profile: owl.profile.list
   • Logging: owl.logging.list
   • Billing: owl.billing.list
   • Log Index: owl.log_index.list
   • Field Catalog: owl.field_schema.get

3. When DQL syntax confirmation is needed, first call owl.data.search_dql_docs to search documentation.

4. After writing the full DQL manually, first call owl.data.check_dql for local validation.
5. Finally, call owl.data.query to execute the formal query.

Profiling Analysis Problems¶

Applicable to problems like "already have a profile_id, want to view summary or parse detailed stack information".

1. First locate the target profile_id in the Profiling data domain via owl.data.query.
2. Call owl.profiling.get_summary to get summary information.
3. Reuse language, type, profile_start, profile_end from the summary result, then call owl.profiling.parse to parse detailed content.

Incident Troubleshooting Problems¶

Applicable to problems like "query incident tickets, track processing progress, add comments".

1. First call owl.incident.list to query incident tickets.

2. Based on incident_uuid, continue calling:

   • owl.incident_comment.list to view comments
   • owl.incident_operation.list to view operation records
   • When processing progress needs to be added, call owl.incident_comment.add.

Dashboard Management Problems¶

Applicable to problems like "creating dashboards, replacing dashboard content, viewing existing dashboard configurations".

1. Call owl.dashboard.create when creating a new dashboard.
2. Call owl.dashboard.replace when replacing an existing dashboard.
3. Call owl.dashboard.get when needing to view current configuration.

Monitor Management Problems¶

Applicable to problems like "viewing monitors, creating monitors, updating monitors, sending test events".

1. First call owl.monitor.list to browse target monitors.
2. Call owl.monitor.get when details are needed.
3. Call owl.monitor.upsert when creating or updating.
4. Call owl.monitor.receive when needing to send external events to verify the reception pipeline.