FlowMetric is the API allowing to create custom metrics from the collected flow logs.
FlowMetric
is the API allowing to create custom metrics from the collected flow logs.
FlowMetric is the API allowing to create custom metrics from the collected flow logs.
object
Property | Type | Description |
---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and might reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers might infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
FlowMetricSpec defines the desired state of FlowMetric
The provided API allows you to customize these metrics according to your needs. When adding new metrics or modifying existing labels, you must carefully monitor the memory
usage of Prometheus workloads as this could potentially have a high impact. Cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric To check the cardinality of all Network Observability metrics, run as |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
object
FlowMetricSpec defines the desired state of FlowMetric
The provided API allows you to customize these metrics according to your needs.
When adding new metrics or modifying existing labels, you must carefully monitor the memory
usage of Prometheus workloads as this could potentially have a high impact. Cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric
To check the cardinality of all Network Observability metrics, run as promql
: count({name=~"netobserv.*"}) by (name)
.
object
metricName
type
Property | Type | Description |
---|---|---|
|
|
A list of buckets to use when |
|
|
Charts configuration, for the OKD Console in the administrator view, Dashboards menu. |
|
|
Filter for ingress, egress or any direction flows.
When set to |
|
|
When nonzero, scale factor (divider) of the value. Metric value = Flow value / Divider. |
|
|
|
|
|
|
|
|
Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_". |
|
|
Metric type: "Counter" or "Histogram". Use "Counter" for any value that increases over time and on which you can compute a rate, such as Bytes or Packets. Use "Histogram" for any value that must be sampled independently, such as latencies. |
|
|
|
Charts configuration, for the OKD Console in the administrator view, Dashboards menu.
array
Configures charts / dashboard generation associated to a metric
object
dashboardName
queries
title
type
Property | Type | Description |
---|---|---|
|
|
Name of the containing dashboard. If this name does not refer to an existing dashboard, a new dashboard is created. |
|
|
List of queries to be displayed on this chart. If |
|
|
Name of the containing dashboard section. If this name does not refer to an existing section, a new section is created.
If |
|
|
Title of the chart. |
|
|
Type of the chart. |
|
|
Unit of this chart. Only a few units are currently supported. Leave empty to use generic number. |
List of queries to be displayed on this chart. If type
is SingleStat
and multiple queries are provided,
this chart is automatically expanded in several panels (one per query).
array
Configures PromQL queries
object
legend
promQL
top
Property | Type | Description |
---|---|---|
|
|
The query legend that applies to each timeseries represented in this chart. When multiple timeseries are displayed, you should set a legend
that distinguishes each of them. It can be done with the following format: |
|
|
The |
|
|
Top N series to display per timestamp. Does not apply to |
filters
is a list of fields and values used to restrict which flows are taken into account. Oftentimes, these filters must
be used to eliminate duplicates: Duplicate != "true"
and FlowDirection = "0"
.
Refer to the documentation for the list of available fields: https://docs.openshift.com/container-platform/latest/observability/network_observability/json-flows-format-reference.html.
array
object
field
matchType
Property | Type | Description |
---|---|---|
|
|
Name of the field to filter on |
|
|
Type of matching to apply |
|
|
Value to filter on. When |