ops.events
Purpose
The ops.events dataset stores the event markers you send through the Coralogix ops-events ingest API, such as CI/CD deployments and custom events like incidents or feature-flag changes. Coralogix stores each event as an opsEvents entity. The same events appear as event markers on APM charts and as annotations.
ops.events is a predefined dataset: Coralogix provisions it in the default dataspace, and the events you send fill it. To send events, see Send events to Coralogix.
Query the dataset
Recent deployments by service:
source default/ops.events
| filter $d.eventType == 'cdEvent'
| choose $m.timestamp, $d.attributes.service.name, $d.cdEvent.pipeline.name, $d.cdEvent.pipeline.result.status
Stored events drop the API's enum prefixes, so filter on the lowercase form: CD_SYSTEM_ARGOCD is stored as argocd, and PIPELINE_RESULT_STATUS_SUCCESS as success.
Schema description
| Field | Type | Required | Description |
|---|---|---|---|
$d | object | Yes | Entity-type-specific payload — shape defined by each entity type's schema |
$d.attributes | object | No | |
$d.attributes.environment | string | No | |
$d.attributes.service | object | No | |
$d.attributes.service.name | string | No | |
$d.cdEvent | object | No | |
$d.cdEvent.pipeline | object | Yes | |
$d.cdEvent.pipeline.name | string | Yes | |
$d.cdEvent.pipeline.result | object | No | |
$d.cdEvent.pipeline.result.status | string | No | One of: success, failure, timeout, cancellation, error, skip. |
$d.cdEvent.pipeline.run | object | No | |
$d.cdEvent.pipeline.run.durationSeconds | integer | No | |
$d.cdEvent.pipeline.run.id | string | No | |
$d.cdEvent.pipeline.run.url | string (uri) | No | |
$d.cdEvent.pipeline.task | object | No | |
$d.cdEvent.pipeline.task.name | string | No | |
$d.cdEvent.pipeline.task.type | string | No | One of: build, test, deploy. |
$d.cdEvent.system | string | Yes | One of: github, argocd, jenkins, gitlab, bitbucket, azure_devops, spinnaker. |
$d.cdEvent.vcs | object | No | |
$d.cdEvent.vcs.ref | object | No | |
$d.cdEvent.vcs.ref.head | object | No | |
$d.cdEvent.vcs.ref.head.name | string | No | |
$d.cdEvent.vcs.ref.head.revision | string | No | |
$d.cdEvent.vcs.repository | object | No | |
$d.cdEvent.vcs.repository.name | string | No | |
$d.cdEvent.vcs.repository.url | string (uri) | No | |
$d.cdEvent.vcs.system | string | No | One of: github, gitlab, bitbucket. |
$d.cdEvent.vcs.type | string | No | One of: branch, tag. |
$d.description | string | No | |
$d.eventType | string | Yes | One of: cdEvent, customEvent. |
$d.schemaVersion | integer | Yes | Revision of this $d contract that produced the record, stamped server-side by ops-events-gateway. Readers branch on this rather than sniffing which fields are present, and must treat an absent value as 1. Bumped only for changes a reader of the previous version cannot survive; additive optional fields keep it. A bump means a new opsEvents/vN schema directory, so within this file the value is always 1. Value: 1. |
$l | map | Yes | User labels: free-form string-to-string map |
$l.<key> | string | No | |
$m | object | Yes | Engine metadata |
$m.cxEventId | string (uuid) | Yes | Globally unique event id |
$m.ingressTimestamp | string (date-time) | Yes | Time the event was ingested |
$m.priorityClass | string | Yes | Defines the feature-set enabled for the event One of: high, medium, low. |
$m.severity | string | Yes | Event severity level One of: Verbose, Debug, Info, Warning, Error, Critical. |
$m.timestamp | string (date-time) | Yes | Event timestamp |
Next steps
- Show events on your charts with Event markers.
- See the other datasets Coralogix provisions in Predefined datasets.
Last updated on