OCSF.Metadata (OCSF v0.1.0)

Copy Markdown View Source

OCSF Metadata object.

Carries event-level metadata such as the schema version, correlation identifiers, and product information. Every OCSF event embeds one %OCSF.Metadata{} struct.

Corresponds to the OCSF Metadata object.

Fields

  • :uid -- unique event identifier. Classified as :identifier.
  • :version -- OCSF schema version (e.g. "1.8.0"). Classified as :taxonomic.
  • :product -- %OCSF.Product{} describing the reporting product. Classified as :taxonomic.
  • :profiles -- list of OCSF profile strings applied to the event. Classified as :taxonomic.
  • :event_code -- optional application-specific event code. Classified as :taxonomic.
  • :correlation_uid -- optional correlation identifier linking related events. Classified as :identifier.
  • :trace_uid -- optional distributed-trace identifier. Classified as :identifier.
  • :span_uid -- optional span identifier within a trace. Classified as :identifier.

PII classification

See OCSF.Classification for data class definitions. Call __ocsf_fields__/0 to inspect this module's field classifications.

See OCSF.Product, OCSF.Correlation, and OCSF.UUID for related modules.

Summary

Types

t()

Functions

__ocsf_fields__()

Return field classification metadata for PII policy enforcement.

Types

t()

@type t() :: %OCSF.Metadata{
  correlation_uid: String.t() | nil,
  event_code: String.t() | nil,
  product: OCSF.Product.t(),
  profiles: [String.t()],
  span_uid: String.t() | nil,
  trace_uid: String.t() | nil,
  uid: String.t(),
  version: String.t()
}

Functions

__ocsf_fields__()

@spec __ocsf_fields__() :: keyword()

Return field classification metadata for PII policy enforcement.