Cisco Observability Platform APIs

The Cisco Observability Platform is a software-as-a-service (SaaS) product that offers cloud native and full-stack observability for large, managed Kubernetes deployments on public clouds such as Amazon Web Services, Microsoft Azure, and Red Hat OpenShift. It provides real-time observability across your entire technology stack: applications, software-defined compute, storage, services, network, and other infrastructure, through the collection and correlation of metrics, events, logs, and traces (MELT).

The Cisco Observability Platform offers several REST APIs that let you extend and customize various aspects of application such as Actions, Anomaly Detection, Application Principal Management Service, Cloud Connections, Common Ingestion Service, Health Rules, and Query Service.

Actions

The Actions API enables you to create, configure, and manage various actions. An action is a predefined, reusable, automated response to an event such as a health violation or an anomaly. See Cisco Observability Platform Actions API.

Note

The Actions API is currently beta and is subject to change. If you adopt a beta API, it may not be fully compatible with future versions.

Anomaly Detection

The Cisco Observability Platform Anomaly Detection determines whether every service in your application performs within the acceptable performance limits. This feature helps to reduce the Mean Time To Detection (MTTD) for application performance problems. The Anomaly Detection Configuration API helps you to create Anomaly Detection configurations for specific entities and entity types. You can also set a sensitivity level such as high, medium, or low, and test for the Anomaly Detection configurations as per your business needs. See Cisco Observability Platform Anomaly Detection Configuration API.

Note

The Anomaly Detection Configuration API is currently beta and is subject to change. If you adopt a beta API, it may not be fully compatible with future versions.

Cloud Connections

The Cisco Observability Platform Cloud Connecdtions API collects data from cloud platforms and correlates that data with the underlying cloud infrastructure. To create cloud connections, you must connect Cloud Observability Platform to one more cloud provider account(s). The Cisco Observability Platform provides HTTP REST APIs to automate the process of creating and managing cloud connections at scale. See Cisco Observability Platform Connections API.

Common Ingestion Service

Traditionally, the Cisco Observability Platform ingests the data that the applications and services generate in multiple ways, which is not an efficient way to store and correlate data. Therefore, the Cisco Observability Platform introduces the Common Ingestion Service API to ingest the data in one, efficient way. The Cisco Observability Platform uses OpenTelemetry as the data ingestion standard. OpenTelemetry is a set of APIs, SDKs, tooling, and integrations designed to create and manage telemetry data such as traces, metrics, and logs. Using the Common Ingestion Service API, AppDynamics and third-party agents can publish OpenTelemetry metric data to the common ingestion pipeline. See Cisco Observability Platform Common Ingestion Service API.

Health Rules

Health rules let you specify the parameters that represent what you consider normal or expected operations for your environment. You can create health rules to monitor one entity or a group of entities. The Health Rules API enables you to programmatically create, update, and manage one or more health rules for the monitored entities. See Cisco Observability Platform Health Rules API.

Note

The Health Rules API is currently beta and is subject to change. If you adopt a beta API, it may not be fully compatible with future versions.

Query Service

The Cisco Observability Platform Query Service API provides access to observation data using the AppDynamics domain-specific language. It allows you to retrieve observation MELT (metrics, events, logs, traces) data using the Cisco Observability Platform Topology. It is a declarative language and supports read-only operation on data. It does not allow any modification of data. See Cisco Observability Platform Query Service API.