package solace.messaging.proto.broker.trace.egress.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Messages with the following topic contain a message matching this specification: _telemetry/broker/trace/egress/v1[/additional/topic/levels] Note that the topic allows for additional topic levels to be added in the future. Receiving clients must not assume there are no additional topic levels. This message describes telemetry data that a Solace PubSub+ broker captures in the egress portion of its data path. Fields with names that end in "time_unix_nano" are 64-bit timestamps, in nanoseconds, since midnight, Jan. 1, 1970 UTC.

• repeated SpanData.EgressSpan egress_spans = 1

• string router_name = 2

  The router-name of the broker generating this message at the time the message was generated.

• optional string message_vpn_name = 3

  The broker's message-vpn name. This field may be removed in the future without a major version change since the field is specified as optional. Rather than rely on this field, receiving clients should obtain the VPN by using an SMF API to extract the VPN_NAME_IN_USE from the API's Session object. The message_vpn_name of all messages received from via an SMF API's session will match the session's VPN_NAME_IN_USE.

• string solos_version = 4

  The SolOS version of the broker generating the message. All elements of egress_spans will always have been created by the same broker version.

The presence of this message implies the reason for the discard was an administrative delete message command. These spans are only generated when the command deletes a single message.

Used in: DeleteSpan

• string username = 1

  The authenticated username of the administrator that requested the operation.

• oneof session_info

  Information identifying the user's session.

  • CliSessionInfo cli_session_info = 2

  • SempSessionInfo semp_session_info = 3

Used in: AdminActionInfo

• oneof descriptor

  CLI Sessions are identified as coming from either a remote SSH connection or from a local terminal. The information provided differs in each case.

  • TerminalCliSessionDescriptor local_session = 1

  • SshCliSessionDescriptor remote_session = 2

• uint32 sessionNumber = 3

  The session number the broker uses to identify a CLI session.

This message contains information unique to a DeleteSpan.

Used in: EgressSpan

• oneof endpoint_name

  The name of the queue or topic endpoint the message is being deleted from.

  • string queue_name = 1

  • string topic_endpoint_name = 2

• oneof type_info

  The nested "info" message below provides the following information: * The reason for the message being deleted. * Any additional information associated with that particular reason. Some reasons have no additional information, so their associated info messages have no fields within them.

  • MaxRedeliveriesInfo max_redeliveries_info = 3

  • TtlExpiredInfo ttl_expired_info = 4

  • RejectedOutcomeInfo rejected_outcome_info = 5

  • HopCountExceededInfo hop_count_exceeded_info = 6

  • IngressSelectorInfo ingress_selector_info = 7

  • AdminActionInfo admin_action_info = 8

• optional uint32 partition_number = 9

  Partition number of the queue the message is being deleted from, if the associated queue is a partitioned queue

Used in: SpanData

• bytes trace_id = 1

  16-byte globally unique trace ID. Any two spans with the same trace ID are part of the same trace.

• bytes span_id = 2

  8-byte span ID, unique within the scope of a trace.

• optional bytes parent_span_id = 3

  If not present, this is a root span. If present, this is an 8-byte span ID of the parent span.

• sfixed64 start_time_unix_nano = 4

  The start and end timestamps of the receive span. The start of the span is when Guaranteed Messaging processing begins in the broker.

• sfixed64 end_time_unix_nano = 5

• optional TransactionEvent transaction_event = 6

• optional string error_description = 7

• oneof type_data

  • SendSpan send_span = 8

  • DeleteSpan delete_span = 9

The presence of this message implies the reason for the span is that the message exceeded its maximum hop count. Hop count limits are used to prevent messages from cycling through a loop indefinitely in a network of brokers. This could be caused by certain bridge configurations. In some documentation an interfaces, this may be referred to as SMF TTL or bridge TTL. Here the term TTL is being avoided to avoid confusion with the Guaranteed Messaging TTL, which is specified as a time duration.

Used in: DeleteSpan

(message has no fields)

The presence of this message implies the reason for the span is that the message did not match a topic endpoint's ingress selector. The message's receive span would have indicated it was being enqueued on the topic endpoint, but before the message is eligible to be delivered to a consumer, the message was discarded because it did not match the ingress selector.

Used in: DeleteSpan

(message has no fields)

The presence of this message implies the reason for the span is that a message exceeded the maximum number of redeliveries.

Used in: DeleteSpan

(message has no fields)

The presence of this message implies the reason for the span is that a consuming client settled the message with an outcome of "rejected".

Used in: DeleteSpan

(message has no fields)

Used in: AdminActionInfo

• uint32 sempVersion = 1

• bytes peer_ip = 2

  A valid IP will be 4 or 16 bytes in length. If the length is 4 bytes, the address is an IPv4 address. If it is 16 bytes, it is an IPv6 address.

This message contains information unique to a SendSpan.

Used in: EgressSpan

• oneof source

  The name of the queue or topic endpoint the message is being delivered from.

  • string queue_name = 1

  • string topic_endpoint_name = 2

• SendSpan.Outcome outcome = 3

• bool replayed_msg = 4

• string consumer_client_username = 5

• string consumer_client_name = 6

• string protocol = 7

• optional string protocol_version = 8

• optional uint32 partition_number = 9

  Partition number of the queue the message is being delivered from, if the associated queue is a partitioned queue

Used in: SendSpan

• ACCEPTED = 0

• REJECTED = 1

• RELEASED = 2

• DELIVERY_FAILED = 3

• FLOW_UNBOUND = 4

• TRANSACTION_COMMIT = 5

• TRANSACTION_COMMIT_FAILED = 6

• TRANSACTION_ROLLBACK = 7

Used in: CliSessionInfo

• bytes peer_ip = 1

  A valid IP will be 4 or 16 bytes in length. If the length is 4 bytes, the address is an IPv4 address. If it is 16 bytes, it is an IPv6 address.

Used in: CliSessionInfo

• string terminal_name = 1

When a span has a transaction event, it indicates the span occurs as part of processing a transaction, and includes the *current* state of of the transaction when the event was generated. The state can change as subsequent events occur as part of the transaction.

Used in: EgressSpan

• sfixed64 time_unix_nano = 1

• TransactionEvent.Type type = 2

• TransactionEvent.Initiator initiator = 3

• oneof transaction_id

  • TransactionEvent.Xid xid = 4

  • TransactionEvent.LocalTransactionId local_id = 5

• optional string error_description = 6

Used in: TransactionEvent

• CLIENT = 0

• ADMIN = 1

• BROKER = 2

Used in: TransactionEvent

• uint32 transaction_id = 1

• uint32 session_id = 2

• string session_name = 3

Used in: TransactionEvent

• COMMIT = 0

  COMMIT and ROLLBACK are always initiated by either a CLIENT or ADMIN. The initiator is ADMIN when the management interface is used to to perform a heuristic commit or rollback.

• ROLLBACK = 1

• END = 2

  PREPARE and END can only occur with a CLIENT initiator, and spans for these operations are only generated if the operation fails. Therefore, the error_description of the TransactionEvent will always be present for END and PREPARE.

• PREPARE = 3

• SESSION_TIMEOUT = 4

  The initiator of a SESSION_TIMEOUT is always BROKER. All messages received as part of the transaction are discarded.

• ROLLBACK_ONLY = 5

  The initiator of ROLLBACK_ONLY is always BROKER. The first such event in a transaction always has an error_description in the span, indicating there was a problem processing the message when it was received, and the message is being discarded. This also transitions the transaction itself to a "rollback only" state, which causes all subsequent messages received as part of the transaction to also be discarded. Spans generated by these subsequent discards will not have the span's error_description set, but all ROLLBACK_ONLY transaction events will have an error_description set, which indicate the transaction's error. Since the only record of these messages in the context of the transaction has been discarded, no further span can be generated in the context of a client, admin, or session timeout operation. When a subsequent operation such as rollback or commit occurs on a transaction marked rollback only, only messages received prior to the error triggering the transition to rollback only will generate receive spans.

Used in: TransactionEvent

• int32 format_id = 1

• bytes branch_qualifier = 2

• bytes global_id = 3

The presence of this message implies the reason for the span is that the message's TTL has expired.

Used in: DeleteSpan

(message has no fields)