Module vector_api_client::gql

source ·
Expand description

GraphQL queries Queries, subscriptions, and extension methods for executing them

Modules§

Structs§

  • ComponentAddedSubscription
    Components subscription for notification when a component has been added
  • ComponentAllocatedBytesSubscription
    ComponentAllocatedBytesSubscription contains metrics on the number of allocated bytes that have been processed by a Vector instance, against specific components.
  • ComponentErrorsTotalsSubscription
    ComponentErrorsTotalsSubscription contains metrics on the number of errors (metrics ending in _errors_total), against specific components.
  • ComponentReceivedBytesThroughputsSubscription
    ComponentReceivedBytesThroughputsSubscription contains metrics on the number of bytes that have been received between interval samples, against specific components.
  • ComponentReceivedBytesTotalsSubscription
    ComponentReceivedBytesTotalsSubscription contains metrics on the number of bytes that have been received by a Vector instance, against a specific component.
  • ComponentReceivedEventsThroughputsSubscription
    ComponentReceivedEventsThroughputsSubscription contains metrics on the number of events that have been accepted for processing between interval samples, against specific components.
  • ComponentReceivedEventsTotalsSubscription
    ComponentReceivedEventsTotalsSubscription contains metrics on the number of events that have been accepted for processing by a Vector instance, against specific components.
  • ComponentRemovedSubscription
    Components subscription for notification when a component has been removed
  • ComponentSentBytesThroughputsSubscription
    ComponentSentBytesThroughputsSubscription contains metrics on the number of bytes that have been received between interval samples, against specific components.
  • ComponentSentBytesTotalsSubscription
    ComponentSentBytesTotalsSubscription contains metrics on the number of bytes that have been received by a Vector instance, against a specific component.
  • ComponentSentEventsThroughputsSubscription
    ComponentSentEventsThroughputsSubscription contains metrics on the number of events that have been emitted between interval samples, against specific components.
  • ComponentSentEventsTotalsSubscription
    ComponentSentEventsTotalsSubscription contains metrics on the number of events that have been emitted by a Vector instance, against specific components.
  • ComponentsQuery
    Components query for returning sources, transforms, and sinks
  • HealthQuery
    HealthQuery is generally used to assert that the GraphQL API server is alive. The health field returns true.
  • HeartbeatSubscription
    HeartbeatSubscription is a subscription that returns a ‘heartbeat’ in the form of a UTC timestamp. The use-case is allowing a client to assert that the server is sending regular payloads, by using the timestamp to determine when the last healthcheck was successful.
  • MetaVersionStringQuery
    MetaVersionStringQuery returns the version string of the queried Vector instance.
  • OutputEventsByComponentIdPatternsSubscription
    OutputEventsByComponentIdPatternsSubscription allows observability into the events that are generated from component(s).
  • UptimeSubscription
    UptimeSubscription returns uptime metrics to determine how long the Vector instance has been running.

Enums§

  • TapEncodingFormat
    Tap encoding format type that is more convenient to use for public clients than the generated output_events_by_component_id_patterns_subscription::EventEncodingType.

Traits§