Filter metrics#

Overview#

Introduction#

A Packet Inspector 2 filter exposes metrics that you can scrape using Prometheus.

Metric endpoint configuration#

Istio proxy (Envoy) metrics are available at the following endpoint.

Port

Endpoint

15090

/stats/prometheus

Metric types#

Metric types are defined by Prometheus. Learn about Prometheus metric types.

Observe metrics in Grafana using the sample dashboard#

Introduction#

If you want to observe metrics for Packet Inspector 2 in Grafana, you can import the sample Packet Inspector 2 dashboard provided with Aspen Mesh to use as a starting point for your own dashboard.

Before you begin#

Before you can observe metrics for Packet Inspector 2 in Grafana, make sure the following software is installed on your cluster:

  • Prometheus

  • Grafana

  • Packet Inspector 2

Import the sample dashboard#

  1. Log in to Grafana.

  2. Click Dashboards in the left-side menu.

  3. Click the New pop-up menu, and then choose Import.

  4. Upload the following dashboard JSON file:

    • Directory: samples/aspenmesh/dashboards (in the Aspen Mesh release directory)

    • File: packet-inspector-2-dashboard.json

  5. Select your Prometheus data source in the pop-up menu.

  6. Click Import.

Diameter communication#

About Diameter communication#

In the Diameter protocol, the client opens the communication, but both the client and server can send requests and receive answers.

Diameter communication diagram#

This diagram shows the components involved in Diameter communication and defines the downstream and upstream directions referred to in the Diameter metrics:

../_images/diameter-communication-diagram.svg

Istio-proxy terminology#

This table defines Istio proxy (Envoy) terminology used in the Diameter filter metrics:

Term

Definition

Downstream host

An entity that connects to an Istio proxy (Envoy).

Example
In the preceding diagram:
- Istio proxy A’s (as well as Filter A’s) downstream host is Application A.
- Istio proxy B’s (as well as Filter B’s) downstream host is Istio proxy A.

Upstream host

An entity that an Istio proxy (Envoy) connects to.

Example
In the preceding diagram:
- Istio proxy A’s (as well as Filter A’s) upstream host is Istio proxy B.
- Istio proxy B’s (as well as Filter B’s) upstream host is Application B.

Metrics#

envoy_f5_diameter_connections_established_total#

Description#

The number of established Diameter connections that have been observed by a filter

Type#

Counter

envoy_f5_diameter_downstream_answers_total#

Description#

The number of Diameter Answer messages received by a filter from the downstream host

Type#

Counter

envoy_f5_diameter_downstream_partial_messages_total#

Description#

The number of partial Diameter messages received by a filter from the downstream host. Additional data from the socket is required to complete a full Diameter message.

Type#

Counter

envoy_f5_diameter_downstream_requests_total#

Description#

The number of Diameter Request messages received by a filter from the downstream host

Type#

Counter

envoy_f5_diameter_grpc_unary_requests_total_failure#

Description#

The number of Diameter messages that were sent as unary gRPC requests and were not received by the analysis service

Type#

Counter

envoy_f5_diameter_grpc_unary_requests_total_success#

Description#

The number of Diameter messages that were sent as unary gRPC requests and were received by the analysis service

Type#

Counter

envoy_f5_diameter_upstream_answers_total#

Description#

The number of Diameter Answer messages received by a filter from the upstream host

Type#

Counter

envoy_f5_diameter_upstream_partial_messages_total#

Description#

The number of partial Diameter messages received by a filter from the upstream host. Additional data from the socket is required to complete a full Diameter message.

Type#

Counter

envoy_f5_diameter_upstream_requests_total#

Description#

The number of Diameter Request messages received by a filter from the upstream host

Type#

Counter

envoy_f5_tap_requests_total_failure#

Description#

The number of HTTP messages that were sent as unary gRPC requests and were not received by the analysis service

Type#

Counter

envoy_f5_tap_requests_total_success#

Description#

The number of HTTP messages that were sent as unary gRPC requests and were received by the analysis service

Type#

Counter