This documentation and the Cisco Observability Platform functionalities it describes are subject to change. Data saved on the platform may disappear and APIs may change without notice.
Define MELT Types
Your domain model must define knowledge objects for incoming MELT data of certain types. The following table lists all the types of incoming MELT data. The types marked Required must have knowledge objects defined for them in your domain model. MELT data belonging to types that are not marked Required can be ingested and displayed in the user interface without being defined in your domain model.
| MELT Type | Knowledge Object | Required? |
|---|---|---|
| Metric | fmm:metric | Yes |
| Event | fmm:event | Yes |
| Log | N/A | No |
| Trace | N/A | No |
Metrics
The Cisco Observability Platform needs to store incoming metrics in fmm:metric knowledge objects. To define the metrics that your solution needs:
In a new file,
<your-solution-name>/fmm/objects/metric.json, define an array of knowledge objects of type fmm:metric.Add the new
fmm:metricobject to your solution:Make the following changes to your solution manifest file (
<your-solution-name>/manifest.json):- In
dependencies, addfmm. - In
objects, add this snippet:
{ "type": "fmm:metric", "objectsFile": "fmm/objects/metric.json" }- In
Validate
manifest.jsonwith the command fsoc solution validate.
If you've already defined any
fmm:entityobjects, add a reference to thisfmm:metricobject to eachfmm:entitydefinition. See Define Entities.
Shortcut To create a file with an empty fmm:metric, run the fsoc solution extend command from the root folder of your solution:
fsoc solution extend –-add-metric=<metric-name>
where <metric-name>:
- Must start with an alphabetical character
- Can only contain alphabetical characters and numbers
- Can contain a maximum of 25 characters
Dynamic Metrics
Dynamic metrics are metrics that a tenant receives that aren't predefined by fmm:metric configurations in any solution that the tenant is subscribed to. This feature is beneficial because solutions don't need to predefine all metrics that they might want to associate with their data model. If the platform identifies an incoming metric as dynamic (in other words, the metric's attributes don't match an any existing fmm:metric), and the metric's attributes match the attributes of any existing fmm:entity, the platform autocreates fmm:metric and fmm:extension configurations for that metric. The fmm:extension associates the metric with the correct fmm:entity. The platform supports a maximum of 200 dynamic metrics per entity type.
The fully qualified type name of a dynamic metric is dynamicmetrics:<metric-name>, whereas the fully qualified type name of a predefined metric is <solution-name>:<metric-name>. Solutions don't need to declare a dependency on the system component dynamicmetrics in their manifest.json.
Note: Solutions must define an entity's attributes in such a unique way that a dynamic metric will only map to that entity definition.
Dynamic metrics are similar to custom metrics in the AppDynamics APM product.
Events
The Cisco Observability Platform needs to store incoming events in fmm:event knowledge objects. To define the events that your solution needs:
In a new file,
<your-solution-name>/fmm/objects/event.json, define an array of knowledge objects of type fmm:event.Add the new
fmm:eventobject to your solution:Make the following changes to your solution manifest file (
<your-solution-name>/manifest.json):- In
dependencies, addfmm. - In
objects, add this snippet:
{ "type": "fmm:event", "objectsFile": "fmm/objects/event.json" }- In
Validate
manifest.jsonwith the command fsoc solution validate.
If you've already defined any
fmm:entityobjects, add a reference to thisfmm:eventobject to each definition. See Define Entities.
Shortcut To create a file with an empty fmm:event, run the fsoc solution extend command from the root folder of your solution:
fsoc solution extend –-add-event=<event-name>
where <event-name>:
- Must start with an alphabetical character.
- Can only contain alphabetical characters and numbers.
- Can contain a maximum of 25 characters.
Logs
See Create Parsing Rules and Mask Sensitive Data.