Chapter 14. FlowMetric configuration parameters
Chapter 14. FlowMetric configuration parameters FlowMetric is the API allowing to create custom metrics from the collected flow logs. 14.1. FlowMetric [flows.netobserv.io/v1alpha1] Description FlowMetric is the API allowing to create custom metrics from the collected flow logs. Type object Property Type Description apiVersion string 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 string 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 metadata object Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec 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 ) . 14.1.1. .metadata Description Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Type object 14.1.2. .spec Description 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 ) . Type object Required metricName type Property Type Description buckets array (string) A list of buckets to use when type is "Histogram". The list must be parsable as floats. When not set, Prometheus default buckets are used. charts array Charts configuration, for the OpenShift Container Platform Console in the administrator view, Dashboards menu. direction string Filter for ingress, egress or any direction flows. When set to Ingress , it is equivalent to adding the regular expression filter on FlowDirection : 0|2 . When set to Egress , it is equivalent to adding the regular expression filter on FlowDirection : 1|2 . divider string When nonzero, scale factor (divider) of the value. Metric value = Flow value / Divider. filters array 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 . flatten array (string) flatten is a list of list-type fields that must be flattened, such as Interfaces and NetworkEvents. Flattened fields generate one metric per item in that field. For instance, when flattening Interfaces on a bytes counter, a flow having Interfaces [br-ex, ens5] increases one counter for br-ex and another for ens5 . labels array (string) labels is a list of fields that should be used as Prometheus labels, also known as dimensions. From choosing labels results the level of granularity of this metric, and the available aggregations at query time. It must be done carefully as it impacts the metric cardinality (cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric ). In general, avoid setting very high cardinality labels such as IP or MAC addresses. "SrcK8S_OwnerName" or "DstK8S_OwnerName" should be preferred over "SrcK8S_Name" or "DstK8S_Name" as much as possible. 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 . metricName string Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_". remap object (string) Set the remap property to use different names for the generated metric labels than the flow fields. Use the origin flow fields as keys, and the desired label names as values. type string 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. valueField string valueField is the flow field that must be used as a value for this metric. This field must hold numeric values. Leave empty to count flows rather than a specific value per flow. 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 . 14.1.3. .spec.charts Description Charts configuration, for the OpenShift Container Platform Console in the administrator view, Dashboards menu. Type array 14.1.4. .spec.charts[] Description Configures charts / dashboard generation associated to a metric Type object Required dashboardName queries title type Property Type Description dashboardName string Name of the containing dashboard. If this name does not refer to an existing dashboard, a new dashboard is created. queries array 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). sectionName string Name of the containing dashboard section. If this name does not refer to an existing section, a new section is created. If sectionName is omitted or empty, the chart is placed in the global top section. title string Title of the chart. type string Type of the chart. unit string Unit of this chart. Only a few units are currently supported. Leave empty to use generic number. 14.1.5. .spec.charts[].queries Description 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). Type array 14.1.6. .spec.charts[].queries[] Description Configures PromQL queries Type object Required legend promQL top Property Type Description legend string 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: {{ Label }} . For example, if the promQL groups timeseries per label such as: sum(rate(USDMETRIC[2m])) by (Label1, Label2) , you might write as the legend: Label1={{ Label1 }}, Label2={{ Label2 }} . promQL string The promQL query to be run against Prometheus. If the chart type is SingleStat , this query should only return a single timeseries. For other types, a top 7 is displayed. You can use USDMETRIC to refer to the metric defined in this resource. For example: sum(rate(USDMETRIC[2m])) . To learn more about promQL , refer to the Prometheus documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/ top integer Top N series to display per timestamp. Does not apply to SingleStat chart type. 14.1.7. .spec.filters Description 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 . Type array 14.1.8. .spec.filters[] Description Type object Required field matchType Property Type Description field string Name of the field to filter on matchType string Type of matching to apply value string Value to filter on. When matchType is Equal or NotEqual , you can use field injection with USD(SomeField) to refer to any other field of the flow.