Skip to main content
Star us on GitHub Star

Events

The ziti controller can emit kinds of events, useful for monitoring, management and integration with other systems. They can be enabled in the controller configuration.

Event Types​

ApiSessionEvent​

An ApiSessionEvent is emitted whenever an api session is created, deleted, refreshed or exchanged. Legacy sessions are only ever created or deleted. JWT sessions are created, refreshed and exchanged.

Example:

 {
     "namespace": "edge.apiSessions",
     "event_type": "created",
     "id": "ckvr2r4fs0001oigd6si4akc8",
     "timestamp": "2021-11-08T14:45:45.785561479-05:00",
     "token": "77cffde5-f68e-4ef0-bbb5-731db36145f5",
     "identity_id": "76BB.shC0",
     "ip_address": "127.0.0.1"
}

Namespace​

The namespace for ApiSessionEvents is edge.apiSessions

Fields​

namespace

The namespace is the event group. The namespace for ApiSessionEvents is edge.apiSessions

  • Type: string

event_type

The event_type indicates the type api session event. One of ["created", "deleted", "refreshed", "exchanged"]

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

id

The id is the api session id

  • Type: string

type

The type is the api session type, one of ["legacy", "jwt"]

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

token

The token is the api session token

  • Type: string

identity_id

The identity_id is the id of the identity that the api session belongs to

  • Type: string

ip_address

The ip_address is the IP address from which the identity to connected to require the api session

  • Type: string

CircuitEvent​

Namespace​

The namespace for CircuitEvents is fabric.circuits

Fields​

namespace

The namespace is the event group. The namespace for CircuitEvents is fabric.circuits

  • Type: string

version

The

  • Type: number (uint32)

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

circuit_id

The

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

client_id

The

  • Type: string

service_id

The

  • Type: string

terminator_id

The

  • Type: string

instance_id

The

  • Type: string

creation_timespan

The

  • Type: string containing a duration. Examples: "1s", "5m", "3h"

path

The

  • Type: CircuitPath

link_count

The

  • Type: number (int)

path_cost

The

  • Type: number (uint32)

failure_cause

The

  • Type: string

duration

The

  • Type: string containing a duration. Examples: "1s", "5m", "3h"

tags

The

  • Type: map of string -> string

CircuitPath​

Fields​

nodes

The

  • Type: list of string

links

The

  • Type: list of string

ingress_id

The

  • Type: string

egress_id

The

  • Type: string

initiator_local_addr

The

  • Type: string

initiator_remote_addr

The

  • Type: string

terminator_local_addr

The

  • Type: string

terminator_remote_addr

The

  • Type: string

ClusterEvent​

Namespace​

The namespace for ClusterEvents is cluster

Fields​

namespace

The namespace is the event group. The namespace for ClusterEvents is cluster

  • Type: string

eventType

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

index

The

  • Type: number (uint64)

peers

The

  • Type: list of ClusterPeer

leaderId

The

  • Type: string

ApiAddress​

Fields​

url

The

  • Type: string

version

The

  • Type: string

ClusterPeer​

Fields​

id

The

  • Type: string

addr

The

  • Type: string

version

The

  • Type: string

apiAddresses

The

  • Type: map of string -> list of ApiAddress

ConnectEvent​

Namespace​

The namespace for ConnectEvents is connect

Fields​

namespace

The namespace is the event group. The namespace for ConnectEvents is connect

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

src_type

The

  • Type: string

dst_type

The

  • Type: string

src_id

The

  • Type: string

src_addr

The

  • Type: string

dst_id

The

  • Type: string

dst_addr

The

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

EntityChangeEvent​

Namespace​

The namespace for EntityChangeEvents is entityChange

Fields​

namespace

The namespace is the event group. The namespace for EntityChangeEvents is entityChange

  • Type: string

eventId

The

  • Type: string

eventType

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

metadata

The

  • Type: map of string -> object

entityType

The

  • Type: string

isParentEvent

The

  • Type: boolean

initialState

The

  • Type: object

finalState

The

  • Type: object

EntityCountEvent​

Namespace​

The namespace for EntityCountEvents is edge.entityCounts

Fields​

namespace

The namespace is the event group. The namespace for EntityCountEvents is edge.entityCounts

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

counts

The

  • Type: map of string -> number (int64)

error

The

  • Type: string

LinkEvent​

Namespace​

The namespace for LinkEvents is fabric.links

Fields​

namespace

The namespace is the event group. The namespace for LinkEvents is fabric.links

  • Type: string

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

link_id

The

  • Type: string

src_router_id

The

  • Type: string

dst_router_id

The

  • Type: string

protocol

The

  • Type: string

dial_address

The

  • Type: string

cost

The

  • Type: number (int32)

connections

The

  • Type: list of LinkConnection

LinkConnection​

Fields​

id

The

  • Type: string

local_addr

The

  • Type: string

remote_addr

The

  • Type: string

MetricsEvent​

Namespace​

The namespace for MetricsEvents is metrics

Fields​

metric_type

The

  • Type: string

namespace

The namespace is the event group. The namespace for MetricsEvents is metrics

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

source_id

The

  • Type: string

source_entity_id

The

  • Type: string

version

The

  • Type: number (uint32)

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

metric

The

  • Type: string

metrics

The

  • Type: map of string -> object

tags

The

  • Type: map of string -> string

source_event_id

The

  • Type: string

RouterEvent​

Namespace​

The namespace for RouterEvents is fabric.routers

Fields​

namespace

The namespace is the event group. The namespace for RouterEvents is fabric.routers

  • Type: string

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

router_id

The

  • Type: string

router_online

The

  • Type: boolean

SdkEvent​

Namespace​

The namespace for SdkEvents is sdk

Fields​

namespace

The namespace is the event group. The namespace for SdkEvents is sdk

  • Type: string

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

identity_id

The

  • Type: string

ServiceEvent​

Namespace​

The namespace for ServiceEvents is services

Fields​

namespace

The namespace is the event group. The namespace for ServiceEvents is services

  • Type: string

version

The

  • Type: number (uint32)

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

service_id

The

  • Type: string

terminator_id

The

  • Type: string

count

The

  • Type: number (uint64)

interval_start_utc

The

  • Type: number (int64)

interval_length

The

  • Type: number (uint64)

SessionEvent​

Namespace​

The namespace for SessionEvents is edge.sessions

Fields​

namespace

The namespace is the event group. The namespace for SessionEvents is edge.sessions

  • Type: string

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

session_type

The

  • Type: string

id

The

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

token

The

  • Type: string

api_session_id

The

  • Type: string

identity_id

The

  • Type: string

service_id

The

  • Type: string

TerminatorEvent​

Namespace​

The namespace for TerminatorEvents is fabric.terminators

Fields​

namespace

The namespace is the event group. The namespace for TerminatorEvents is fabric.terminators

  • Type: string

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

timestamp

The timestamp is the datetime that the event was generated

  • Type: string containing an RFC3339 formatted timestamp (example: "2024-10-02T12:17:39.501821249-04:00")

service_id

The

  • Type: string

terminator_id

The

  • Type: string

router_id

The

  • Type: string

host_id

The

  • Type: string

router_online

The

  • Type: boolean

precedence

The

  • Type: string

static_cost

The

  • Type: number (uint16)

dynamic_cost

The

  • Type: number (uint16)

total_terminators

The

  • Type: number (int)

usable_default_terminators

The

  • Type: number (int)

usable_required_terminators

The

  • Type: number (int)

UsageEvent​

Namespace​

The namespace for UsageEvents is fabric.usage

Fields​

namespace

The namespace is the event group. The namespace for UsageEvents is fabric.usage

  • Type: string

version

The

  • Type: number (uint32)

event_type

The

  • Type: string

event_src_id

The event_src_id is the identifier of the controller which emitted the event

  • Type: string

source_id

The

  • Type: string

circuit_id

The

  • Type: string

usage

The

  • Type: number (uint64)

interval_start_utc

The

  • Type: number (int64)

interval_length

The

  • Type: number (uint64)

tags

The

  • Type: map of string -> string