Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 3.35 KB

File metadata and controls

64 lines (43 loc) · 3.35 KB

Semantic Conventions for Contrast Actions

Actions are a concept for Security Observability. They are modeled as a metric so that actions are seen for every requests and collected in a scalable manner for the agent. We will never miss an action on a particular execution path.

The data used in the action is captured as attributes within a span of a trace. Since capturing and processing spans is considered an expensive activity, this data is captured as part of a sampling activity.

Information in traces allow us to construct an action graph of the execution ordering and also gives us the same data used within an action. However, since they are sampled, its possible to miss some execution paths that execute other actions. Metrics contain what actions have occurred on an endpoint and are captured for every request, thus they will never miss a particular action. This fidelity comes at a cost however in that metrics will not contain data used in an action nor will it contain enough information to determine the action execution order.

Actions

Metrics

Spans

Resource additions from Contrast

Status: Experimental

type: contrast

Description: Additional attributes for Contrast Sensors to provide

Attribute Type Description Examples Requirement Level Stability
contrast.deployment string deployment environment QA; DEVELOPMENT; PRODUCTION Recommended Experimental
contrast.semconv.version string The version of contrast semantic conventions the data adheres to. 0.3.0 Recommended Experimental
otel.semconv.version string The version of otel semantic conventions the data adheres to. 1.22.0 Recommended Experimental

contrast.deployment has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
DEVELOPMENT development environment Experimental
PRODUCTION production environment Experimental
QA quality assurance environment Experimental