Collaboration diagram for Trace chunk archive location API:

Warning

The documentation of the trace chunk archive API is incomplete.

The text below shows the typical usage of this API, but the types, enumerators, and functions of lttng/location.h aren't documented individually.

A trace chunk archive location indicates where LTTng wrote a recording session trace chunk archive after a recording session rotation or destruction.

The type of a trace chunk archive location is #lttng_trace_archive_location.

A trace chunk archive location can refer to a local directory or to a remote LTTng relay daemon (see lttng-relayd(8)).

To inspect an existing trace chunk archive location, call lttng_trace_archive_location_get_type() to get its type (enumerator of #lttng_trace_archive_location_type). Depending on the returned type:

Location type

Type enumerator

Property access

Local filesystem location

#LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL

Borrow the absolute directory path with lttng_trace_archive_location_local_get_absolute_path().

Remote location (LTTng relay daemon)

#LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY

Retrieve:

The protocol type (enumerator of #lttng_trace_archive_location_relay_protocol_type) with lttng_trace_archive_location_relay_get_protocol_type().
The relay daemon host (hostname or IP address) with lttng_trace_archive_location_relay_get_host() (borrowed).
The control port with lttng_trace_archive_location_relay_get_control_port().
The data port with lttng_trace_archive_location_relay_get_data_port().
The path, relative to the output directory of the relay daemon, with lttng_trace_archive_location_relay_get_relative_path() (borrowed).

Each accessor returns an #lttng_trace_archive_location_status enumerator amongst:

#LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK

Success.

#LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_INVALID

Unsatisfied precondition.

#LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_ERROR

Other error.