package observer

Get desktop application:
View/edit binary Protocol Buffers messages

Observer returns a stream of Flows depending on which filter the user want to observe.

• rpc GetFlows (GetFlowsRequest, stream GetFlowsResponse)

  observer.proto:21

  GetFlows returning structured data, meant to eventually obsolete GetLastNFlows.

  message GetFlowsRequest

  observer.proto:83

  • uint64 number = 1

    Number of flows that should be returned. Incompatible with `since/until`. Defaults to the most recent (last) `number` flows, unless `first` is true, then it will return the earliest `number` flows.

  • bool first = 9

    first specifies if we should look at the first `number` flows or the last `number` of flows. Incompatible with `follow`.

  • bool follow = 3

    follow sets when the server should continue to stream flows after printing the last N flows.

  • repeated flow.FlowFilter blacklist = 5

    blacklist defines a list of filters which have to match for a flow to be excluded from the result. If multiple blacklist filters are specified, only one of them has to match for a flow to be excluded.

  • repeated flow.FlowFilter whitelist = 6

    whitelist defines a list of filters which have to match for a flow to be included in the result. If multiple whitelist filters are specified, only one of them has to match for a flow to be included. The whitelist and blacklist can both be specified. In such cases, the set of the returned flows is the set difference `whitelist - blacklist`. In other words, the result will contain all flows matched by the whitelist that are not also simultaneously matched by the blacklist.

  • optional google.protobuf.Timestamp since = 7

    Since this time for returned flows. Incompatible with `number`.

  • optional google.protobuf.Timestamp until = 8

    Until this time for returned flows. Incompatible with `number`.

  • optional google.protobuf.FieldMask field_mask = 10

    FieldMask allows clients to limit flow's fields that will be returned. For example, {paths: ["source.id", "destination.id"]} will return flows with only these two fields set.

  • optional GetFlowsRequest.Experimental experimental = 999

  • optional google.protobuf.Any extensions = 150000

    extensions can be used to add arbitrary additional metadata to GetFlowsRequest. This can be used to extend functionality for other Hubble compatible APIs, or experiment with new functionality without needing to change the public API.

  message GetFlowsResponse

  observer.proto:145

  GetFlowsResponse contains either a flow or a protocol message.

  • oneof response_types

    • flow.Flow flow = 1

    • relay.NodeStatusEvent node_status = 2

      node_status informs clients about the state of the nodes participating in this particular GetFlows request.

    • flow.LostEvent lost_events = 3

      lost_events informs clients about events which got dropped due to a Hubble component being unavailable

  • string node_name = 1000

    Name of the node where this event was observed.

  • optional google.protobuf.Timestamp time = 1001

    Timestamp at which this event was observed.

• rpc GetAgentEvents (GetAgentEventsRequest, stream GetAgentEventsResponse)

  observer.proto:24

  GetAgentEvents returns Cilium agent events.

  message GetAgentEventsRequest

  observer.proto:161

  • uint64 number = 1

    Number of flows that should be returned. Incompatible with `since/until`. Defaults to the most recent (last) `number` events, unless `first` is true, then it will return the earliest `number` events.

  • bool first = 9

    first specifies if we should look at the first `number` events or the last `number` of events. Incompatible with `follow`.

  • bool follow = 2

    follow sets when the server should continue to stream agent events after printing the last N agent events.

  • optional google.protobuf.Timestamp since = 7

    Since this time for returned agent events. Incompatible with `number`.

  • optional google.protobuf.Timestamp until = 8

    Until this time for returned agent events. Incompatible with `number`.

  message GetAgentEventsResponse

  observer.proto:186

  GetAgentEventsResponse contains an event received from the Cilium agent.

  • optional flow.AgentEvent agent_event = 1

  • string node_name = 1000

    Name of the node where this event was observed.

  • optional google.protobuf.Timestamp time = 1001

    Timestamp at which this event was observed.

• rpc GetDebugEvents (GetDebugEventsRequest, stream GetDebugEventsResponse)

  observer.proto:27

  GetDebugEvents returns Cilium datapath debug events.

  message GetDebugEventsRequest

  observer.proto:194

  • uint64 number = 1

    Number of events that should be returned. Incompatible with `since/until`. Defaults to the most recent (last) `number` events, unless `first` is true, then it will return the earliest `number` events.

  • bool first = 9

    first specifies if we should look at the first `number` events or the last `number` of events. Incompatible with `follow`.

  • bool follow = 2

    follow sets when the server should continue to stream debug events after printing the last N debug events.

  • optional google.protobuf.Timestamp since = 7

    Since this time for returned debug events. Incompatible with `number`.

  • optional google.protobuf.Timestamp until = 8

    Until this time for returned debug events. Incompatible with `number`.

  message GetDebugEventsResponse

  observer.proto:219

  GetDebugEventsResponse contains a Cilium datapath debug events.

  • optional flow.DebugEvent debug_event = 1

  • string node_name = 1000

    Name of the node where this event was observed.

  • optional google.protobuf.Timestamp time = 1001

    Timestamp at which this event was observed.

• rpc GetNodes (GetNodesRequest, GetNodesResponse)

  observer.proto:30

  GetNodes returns information about nodes in a cluster.

  message GetNodesRequest

  observer.proto:227

  (message has no fields)

  message GetNodesResponse

  observer.proto:230

  GetNodesResponse contains the list of nodes.

  • repeated Node nodes = 1

    Nodes is an exhaustive list of nodes.

• rpc GetNamespaces (GetNamespacesRequest, GetNamespacesResponse)

  observer.proto:36

  GetNamespaces returns information about namespaces in a cluster. The namespaces returned are namespaces which have had network flows in the last hour. The namespaces are returned sorted by cluster name and namespace in ascending order.

  message GetNamespacesRequest

  observer.proto:273

  (message has no fields)

  message GetNamespacesResponse

  observer.proto:276

  GetNamespacesResponse contains the list of namespaces.

  • repeated Namespace namespaces = 1

    Namespaces is a list of namespaces with flows

• rpc ServerStatus (ServerStatusRequest, ServerStatusResponse)

  observer.proto:39

  ServerStatus returns some details about the running hubble server.

  message ServerStatusRequest

  observer.proto:42

  (message has no fields)

  message ServerStatusResponse

  observer.proto:44

  • uint64 num_flows = 1

    number of currently captured flows In a multi-node context, this is the cumulative count of all captured flows.

  • uint64 max_flows = 2

    maximum capacity of the ring buffer In a multi-node context, this is the aggregation of all ring buffers capacities.

  • uint64 seen_flows = 3

    total amount of flows observed since the observer was started In a multi-node context, this is the aggregation of all flows that have been seen.

  • uint64 uptime_ns = 4

    uptime of this observer instance in nanoseconds In a multi-node context, this field corresponds to the uptime of the longest living instance.

  • optional google.protobuf.UInt32Value num_connected_nodes = 5

    number of nodes for which a connection is established

  • optional google.protobuf.UInt32Value num_unavailable_nodes = 6

    number of nodes for which a connection cannot be established

  • repeated string unavailable_nodes = 7

    list of nodes that are unavailable This list may not be exhaustive.

  • string version = 8

    Version is the version of Cilium/Hubble.

  • double flows_rate = 9

    Approximate rate of flows seen by Hubble per second over the last minute. In a multi-node context, this is the sum of all flows rates.

ExportEvent contains an event to be exported. Not to be used outside of the exporter feature.

• oneof response_types

  • flow.Flow flow = 1

  • relay.NodeStatusEvent node_status = 2

    node_status informs clients about the state of the nodes participating in this particular GetFlows request.

  • flow.LostEvent lost_events = 3

    lost_events informs clients about events which got dropped due to a Hubble component being unavailable

  • flow.AgentEvent agent_event = 4

    agent_event informs clients about an event received from the Cilium agent.

  • flow.DebugEvent debug_event = 5

    debug_event contains Cilium datapath debug events

• string node_name = 1000

  Name of the node where this event was observed.

• optional google.protobuf.Timestamp time = 1001

  Timestamp at which this event was observed.

Experimental contains fields that are not stable yet. Support for experimental features is always optional and subject to change.

Used in: GetFlowsRequest

• optional google.protobuf.FieldMask field_mask = 1

  FieldMask allows clients to limit flow's fields that will be returned. For example, {paths: ["source.id", "destination.id"]} will return flows with only these two fields set. Deprecated in favor of top-level field_mask. This field will be removed in v1.17.

Used in: GetNamespacesResponse

• string cluster = 1

• string namespace = 2

Node represents a cluster node.

Used in: GetNodesResponse

• string name = 1

  Name is the name of the node.

• string version = 2

  Version is the version of Cilium/Hubble as reported by the node.

• string address = 3

  Address is the network address of the API endpoint.

• relay.NodeState state = 4

  State represents the known state of the node.

• optional TLS tls = 5

  TLS reports TLS related information.

• uint64 uptime_ns = 6

  UptimeNS is the uptime of this instance in nanoseconds

• uint64 num_flows = 7

  number of currently captured flows

• uint64 max_flows = 8

  maximum capacity of the ring buffer

• uint64 seen_flows = 9

  total amount of flows observed since the observer was started

TLS represents TLS information.

Used in: Node

• bool enabled = 1

  Enabled reports whether TLS is enabled or not.

• string server_name = 2

  ServerName is the TLS server name that can be used as part of the TLS cert validation process.