Cloud Trace Service (CTS)¶

The CTS client is the command-line interface (CLI) for the Cloud Trace Service (CTS) API and its extensions.

For help on a specific cts command, enter:

$ openstack cts help SUBCOMMAND

Traces operations¶

cts trace list¶

List CTS traces

openstack cts trace list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--tracker <tracker>]
    [--limit <limit>]
    [--next <next>]
    [--service_type <type>]
    [--resource_type <resource_type>]
    [--resource_id <resource_id>]
    [--resource_name <resource_name>]
    [--trace_name <name>]
    [--trace_id <id>]
    [--level {NORMAL,WARNING,INCIDENT}]
    [--user <user>]
    [--start_time <yyyy-MM-ddTHH:mm:ss>]
    [--end_time <yyyy-MM-ddTHH:mm:ss>]
    [--long]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--tracker <tracker>¶: Tracker name (currently only system)

--limit <limit>¶: Limit number of records to return.

--next <next>¶: ID of the previous trace to paginate output.

--service_type <type>¶: Service type to query traces for.

--resource_type <resource_type>¶: Resource type to query traces for.

--resource_id <resource_id>¶: Resource ID to query traces for.

--resource_name <resource_name>¶: Resource name to query traces for.

--trace_name <name>¶: Trace name (operation) to query traces for.

--trace_id <id>¶: Trace id to query traces for.

--level {NORMAL,WARNING,INCIDENT}¶: Trace level to query traces for.

--user <user>¶: User name to query traces for.

--start_time <yyyy-MM-ddTHH:mm:ss>¶: Start time of the period to be queried.

--end_time <yyyy-MM-ddTHH:mm:ss>¶: End time of the period to be queried.

--long¶: Return long format.

This command is provided by the otcextensions plugin.

Tracker operations¶

cts tracker create¶

Create a single CTS tracker

openstack cts tracker create
    --bucket_name <bucket>
    [--file_prefix_name <file_prefix_name>]
    [--enable_smn]
    [--topic_id <topic>]
    [--operation {create,delete,login}]
    [--send_all_key]
    [--notify_user <user>]

--bucket_name <bucket>¶: Specifies the OBS bucket name. The value is a string of 0 to 64 characters and can contain uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), hyphens (-), underscores (_), and periods (.). In addition, it must start and end with a letter.

--file_prefix_name <file_prefix_name>¶: Specifies the prefix of a log that needs to be stored in an OBS bucket. The value is a string of 0 to 64 characters and can contain uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), hyphens (-), underscores (_), and periods (.)

--enable_smn¶: Specifies whether SMN is supported. When the value is false, topic_id and operations can be left empty.

--topic_id <topic>¶: topic_id is obtained from SMN and in the format of urn:smn: ([A-Za-z0-9-]){1,32}:([A-Za-z0-9]){32}:([A-Za-z0-9]|[_-]){1,256}.

--operation {create,delete,login}¶: Specifies trigger conditions for sending a notification when Typical is selected. You can select Delete, Create, or Login or all of them via repetition. Specifies trigger conditions for sending a notification when –send_all_key is selected. All conditions including Delete, Create, Change, and OpenStack API Event are selected by default. Modification is not allowed.

--send_all_key¶: You can select Typical or All for Trigger Condition. When the value is false, operations cannot be left empty. When the value is true, operations is not supported.

--notify_user <user>¶: In Typical scenario, you can specify the users using the login function. When these users log in, notifications will be sent.

This command is provided by the otcextensions plugin.

cts tracker delete¶

Delete CTS Tracker

openstack cts tracker delete <tracker> [<tracker> ...]

tracker¶: Name or ID of the tracker to delete.

This command is provided by the otcextensions plugin.

cts tracker set¶

Update single CTS tracker properties

openstack cts tracker set
    --bucket_name <bucket>
    [--file_prefix_name <file_prefix_name>]
    [--enable_smn]
    [--topic_id <topic>]
    [--operation {create,delete,login}]
    [--send_all_key]
    [--notify_user <user>]
    [--enable | --disable]
    <tracker>

--bucket_name <bucket>¶: Specifies the OBS bucket name. The value is a string of 0 to 64 characters and can contain uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), hyphens (-), underscores (_), and periods (.). In addition, it must start and end with a letter.

--file_prefix_name <file_prefix_name>¶: Specifies the prefix of a log that needs to be stored in an OBS bucket. The value is a string of 0 to 64 characters and can contain uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), hyphens (-), underscores (_), and periods (.)

--enable_smn¶: Specifies whether SMN is supported. When the value is false, topic_id and operations can be left empty.

--topic_id <topic>¶: topic_id is obtained from SMN and in the format of urn:smn: ([A-Za-z0-9-]){1,32}:([A-Za-z0-9]){32}:([A-Za-z0-9]|[_-]){1,256}.

--operation {create,delete,login}¶: Specifies trigger conditions for sending a notification when Typical is selected. You can select Delete, Create, or Login or all of them via repetition. Specifies trigger conditions for sending a notification when –send_all_key is selected. All conditions including Delete, Create, Change, and OpenStack API Event are selected by default. Modification is not allowed.

--send_all_key¶: You can select Typical or All for Trigger Condition. When the value is false, operations cannot be left empty. When the value is true, operations is not supported.

--notify_user <user>¶: In Typical scenario, you can specify the users using the login function. When these users log in, notifications will be sent.

--enable¶: Enable tracing into the bucket

--disable¶: Disable tracing into the bucket

tracker¶: Specifies the name of the tracker. Currently only system is supported.

This command is provided by the otcextensions plugin.

cts tracker show¶

Show details of a CTS tracker

openstack cts tracker show <tracker>

tracker¶: Tracker name (currently only system)

This command is provided by the otcextensions plugin.

last updated: UTC - commit: