NAME

OpenTelemetry::Trace::Event - An event associated with an OpenTelemetry span

SYNOPSIS

    use OpenTelemetry::Trace::Event;

    my $event = OpenTelemetry::Trace::Event->new(
        name       => $event_name,
        attributes => \%attributes,
    );

    # Or more realistically
    use OpenTelemetry;

    my $span = OpenTelemetry->tracer_provider->tracer->create_span(...);

    ...

    $span->add_event(
        name       => 'my event',
        attributes => \%attributes,
    );

DESCRIPTION

Spans created by a OpenTelemetry::Trace::Tracer (or one of its subclasses) may record zero or more events. Events can represent all sorts of matters of interest, and the most common ones have been given some standardised names and set of attributes. Please refer to the Semantic Conventions document for details on which these are.

Probably the most common event will be exceptions added through a method like "record_exception" in OpenTelemetry::Trace::Span.

METHODS

This class implements the OpenTelemetry::Attributes role. Please consult that module's documentation for details on the behaviours it provides.

new

    my $event = OpenTelemetry::Trace::Event->new(
        name       => $event_name,
        timestamp  => $timestamp // time,
        attributes => \%attributes,
    );

Create a new event. The name parameter is required and must be set to a string that will identify this event. Note that some event names have standardised meanings. Refer to the Semantic Conventions for details on what these are and what they represent.

The constructor accepts an optional timestamp argument to represent the time at which this event took place. If not provided, the timestamp will be the one at which the event was created. Note that events associated with a span may have a timestamp that took place before their span started, or after it ended.

While the constructor allows you to create events, users will most likely create events on a span using "add_event" in OpenTelemetry::Trace::Span instead.

name

    $name = $event->name;

Reads the name given to this event when created.

timestamp

    $timestamp = $event->timestamp;

Reads the timestamp associated with this event.

SEE ALSO

OpenTelemetry::Attributes

OpenTelemetry::Trace::Span

OpenTelemetry Semantic Conventions

COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by José Joaquín Atria.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.