GaugeName

Enum GaugeName 

Source
pub enum GaugeName {
Show 38 variants ComponentLatencyMeanSeconds, SourceBufferMaxEventSize, SourceBufferMaxByteSize, SourceBufferMaxSizeEvents, SourceBufferMaxSizeBytes, SourceBufferUtilizationLevel, SourceBufferUtilizationMean, TransformBufferMaxEventSize, TransformBufferMaxByteSize, TransformBufferMaxSizeEvents, TransformBufferMaxSizeBytes, TransformBufferUtilizationLevel, TransformBufferUtilizationMean, BufferMaxSizeEvents, BufferMaxEventSize, BufferMaxSizeBytes, BufferMaxByteSize, BufferEvents, BufferSizeEvents, BufferSizeBytes, BufferByteSize, Utilization, ComponentAllocatedBytes, OpenFiles, UptimeSeconds, BuildInfo, KafkaQueueMessages, KafkaQueueMessagesBytes, KafkaConsumerLag, LuaMemoryUsedBytes, OpenConnections, ActiveEndpoints, SplunkPendingAcks, ActiveClients, MemoryEnrichmentTableObjectsCount, MemoryEnrichmentTableByteSize, TagCardinalityTrackedKeys, InternalMetricsCardinality,
}
Expand description

Canonical list of all per-component internal gauge metric names emitted by Vector.

Variants§

§

ComponentLatencyMeanSeconds

The mean elapsed time, in fractional seconds, that an event spends in a single transform.

This includes both the time spent queued in the transform’s input buffer and the time spent executing the transform itself. This value is smoothed over time using an exponentially weighted moving average (EWMA).

§

SourceBufferMaxEventSize

The maximum number of events the source buffer can hold. The outputs of the source send data to this buffer.

§

SourceBufferMaxByteSize

The maximum number of bytes the source buffer can hold. The outputs of the source send data to this buffer.

§

SourceBufferMaxSizeEvents

The maximum number of events the source buffer can hold. The outputs of the source send data to this buffer.

§

SourceBufferMaxSizeBytes

The maximum number of bytes the source buffer can hold. The outputs of the source send data to this buffer.

§

SourceBufferUtilizationLevel

The current utilization level of the source buffer. The outputs of the source send data to this buffer.

§

SourceBufferUtilizationMean

The mean utilization level of the source buffer. The outputs of the source send data to this buffer. The mean utilization is smoothed over time using an exponentially weighted moving average (EWMA).

§

TransformBufferMaxEventSize

The maximum number of events the buffer that feeds into a transform can hold.

§

TransformBufferMaxByteSize

The maximum number of bytes the buffer that feeds into a transform can hold.

§

TransformBufferMaxSizeEvents

The maximum number of events the buffer that feeds into a transform can hold.

§

TransformBufferMaxSizeBytes

The maximum number of bytes the buffer that feeds into a transform can hold.

§

TransformBufferUtilizationLevel

The current utilization level of the buffer that feeds into a transform.

§

TransformBufferUtilizationMean

The mean utilization level of the buffer that feeds into a transform. This value is smoothed over time using an exponentially weighted moving average (EWMA).

§

BufferMaxSizeEvents

The maximum number of events in the buffer.

§

BufferMaxEventSize

The maximum size in events that the buffer can store.

§

BufferMaxSizeBytes

The maximum number of bytes in the buffer.

§

BufferMaxByteSize

The maximum size in bytes that the buffer can store.

§

BufferEvents

The number of events currently in the buffer.

§

BufferSizeEvents

The number of events currently in the buffer.

§

BufferSizeBytes

The number of bytes currently in the buffer.

§

BufferByteSize

The number of bytes currently in the buffer.

§

Utilization

A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.

§

ComponentAllocatedBytes

The number of bytes currently allocated by this component.

§

OpenFiles

The total number of open files.

§

UptimeSeconds

The total number of seconds the Vector instance has been up.

§

BuildInfo

Has a fixed value of 1.0. Contains build information such as Rust and Vector versions.

§

KafkaQueueMessages

Current number of messages in producer queues.

§

KafkaQueueMessagesBytes

Current total size of messages in producer queues.

§

KafkaConsumerLag

The Kafka consumer lag.

§

LuaMemoryUsedBytes

The total memory currently being used by the Lua runtime.

§

OpenConnections

The number of current open connections to Vector.

§

ActiveEndpoints

The number of currently active endpoints.

§

SplunkPendingAcks

The number of outstanding Splunk HEC indexer acknowledgement acks.

§

ActiveClients

Number of clients attached to a component.

§

MemoryEnrichmentTableObjectsCount

The number of objects currently stored in the in-memory enrichment table.

§

MemoryEnrichmentTableByteSize

The total size in bytes of all objects stored in the in-memory enrichment table.

§

TagCardinalityTrackedKeys

The number of tag keys currently being tracked by the tag cardinality limit transform.

§

InternalMetricsCardinality

The total number of metrics emitted from the internal metrics registry.

Implementations§

Source§

impl GaugeName

Source

pub const fn as_str(self) -> &'static str

Trait Implementations§

Source§

impl AsRef<str> for GaugeName

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for GaugeName

Source§

fn clone(&self) -> GaugeName

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Configurable for GaugeName

Source§

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any. Read more
Source§

fn metadata() -> Metadata

Gets the metadata for this value.
Source§

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value. Read more
§

fn is_optional() -> bool
where Self: Sized,

Whether or not this value is optional. Read more
§

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>
where Self: Sized,

Validates the given metadata against this type. Read more
§

fn as_configurable_ref() -> ConfigurableRef
where Self: Sized + 'static,

Create a new configurable reference table.
Source§

impl Debug for GaugeName

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for GaugeName

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for GaugeName

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Hash for GaugeName

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IntoEnumIterator for GaugeName

Source§

impl PartialEq for GaugeName

Source§

fn eq(&self, other: &GaugeName) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for GaugeName

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl ToValue for GaugeName

Source§

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.
Source§

impl Copy for GaugeName

Source§

impl Eq for GaugeName

Source§

impl StructuralPartialEq for GaugeName

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AsOut<T> for T
where T: Copy,

§

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Candidate for T
where T: AsRef<str>,

§

fn display(&self) -> &str

Text to display when listing alternatives.
§

fn replacement(&self) -> &str

Text to insert in line.
§

impl<T> Casing<T> for T
where T: AsRef<str> + ToString,

§

fn to_case(&self, case: Case) -> String

Convert the string into the given case. It will reference self and create a new String with the same pattern and delimeter as case. It will split on boundaries defined at [Boundary::defaults()]. Read more
§

fn with_boundaries(&self, bs: &[Boundary]) -> StateConverter<'_, T>

Creates a StateConverter struct initialized with the boundaries provided. Read more
§

fn without_boundaries(&self, bs: &[Boundary]) -> StateConverter<'_, T>

Creates a StateConverter struct initialized without the boundaries provided. Read more
§

fn from_case(&self, case: Case) -> StateConverter<'_, T>

Start the case conversion by storing the boundaries associated with the given case. Read more
§

fn is_case(&self, case: Case) -> bool

Determines if self is of the given case. This is done simply by applying the conversion and seeing if the result is the same. Read more
§

impl<T> Casing<T> for T
where T: AsRef<str> + ToString,

§

fn to_case(&self, case: Case<'_>) -> String

Convert the string into the given case. It will reference self and create a new String with the same pattern and delimeter as case. It will split on boundaries defined at [Boundary::defaults()]. Read more
§

fn with_boundaries(&self, bs: &[Boundary]) -> StateConverter<'_, T>

Creates a StateConverter struct initialized with the boundaries provided. Read more
§

fn without_boundaries(&self, bs: &[Boundary]) -> StateConverter<'_, T>

Creates a StateConverter struct initialized without the boundaries provided. Read more
§

fn from_case(&self, case: Case<'_>) -> StateConverter<'_, T>

Start the case conversion by storing the boundaries associated with the given case. Read more
§

fn is_case(&self, case: Case<'_>) -> bool

Determines if self is of the given case. This is done simply by applying the conversion and seeing if the result is the same. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<T> EncodedChars for T
where T: AsRef<str>,

§

fn start_ptr(&self) -> *const u8

Pointer to the start of the pattern Read more
§

fn limit_ptr(&self) -> *const u8

Pointer to the limit of the pattern buffer Read more
§

fn len(&self) -> usize

The length of this buffer
§

fn encoding(&self) -> *mut OnigEncodingTypeST

The encoding of the contents of the buffer
§

fn is_empty(&self) -> bool

Is the buffer empty?
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Hint for T
where T: AsRef<str>,

§

fn display(&self) -> &str

Text to display when hint is active
§

fn completion(&self) -> Option<&str>

Text to insert in line when right arrow is pressed
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

§

type Error = <Target as OctetsFrom<Source>>::Error

§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

fn if_supports_color<'a, Out, ApplyFn>( &'a self, stream: impl Into<Stream>, apply: ApplyFn, ) -> SupportsColorsDisplay<'a, Self, Out, ApplyFn>
where ApplyFn: Fn(&'a Self) -> Out,

Apply a given transformation function to all formatters if the given stream supports at least basic ANSI colors, allowing you to conditionally apply given styles/colors. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T