Docs: document the format of the lttng_session path member
authorJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 22 Mar 2019 21:51:14 +0000 (17:51 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 29 Mar 2019 15:49:48 +0000 (11:49 -0400)
commitaf0c0d75dd996dbf21bda2c8364f35c1e2ef7f0a
tree9f736fd8f3733aa65845ba420ca51d2c191a2174
parentd685c8c6e082402837b23be4ad81d9cae59a8a3b
Docs: document the format of the lttng_session path member

Document that the path returned through a session listing operation
is not a path nor standard URL. While a UNIX path will be returned
when a session is configured to trace locally, a liblttng-ctl user
should not expect this field to contain a valid URL when a network
streaming (or live) output destination is configured. The "path"
field will hold a custom-formatted string describing the output.

This is arguably unexepected, but since this is currently the only
way to obtain the destination of an existing session, this format
will not be changed to preserve compatiblity with existing tools
which could rely on this format.

A description of the formating used by the session daemon is
added as part of this patch.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
include/lttng/session.h
This page took 0.025469 seconds and 4 git commands to generate.