Skip to content

Commit

Permalink
feat: DEVOPS-1843 opentelemetry metrics for nodes
Browse files Browse the repository at this point in the history
  • Loading branch information
pavlops committed Feb 10, 2025
1 parent e89370e commit a87aa35
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 44 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/cicd-stg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ on:
push:
branches:
- main
- devops-1843


jobs:
build-makefile:
permissions:
Expand Down Expand Up @@ -90,7 +89,7 @@ jobs:
id-token: write
contents: write
runs-on: ubuntu-22.04
if: github.actor != 'dependabot[bot]' && github.ref_name == 'main'
if: github.actor != 'dependabot[bot]' && github.ref_name == 'devops-1843'
strategy:
fail-fast: false
matrix:
Expand Down
82 changes: 41 additions & 41 deletions zq2/docs/opentelemetry.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
---
id: nodes/opentelemetry
title: OpenTelemetry
keywords:
- Node
- Validator
- Monitor
- OpenTelemetry
- Metrics
description: OpenTelemetry
---

# OpenTelemetry Metrics

[OpenTelemetry](https://opentelemetry.io/) is an open-source observability framework designed to generate, collect, and manage telemetry data (metrics, traces, and logs) in distributed systems. It provides a standardized way to instrument, generate, collect, and export telemetry data for analysis, making it easier to monitor and troubleshoot complex distributed applications.

## Integration with Zilliqa

A Zilliqa node contains various performance and operational metrics compatible with the OpenTelemetry protocol specification. These metrics are useful for:

- Monitoring node performance and health
- Understanding system behavior under different conditions
- Enabling proactive maintenance and troubleshooting

To export the OpenTelemetry metrics, you can define the collector endpoint with the `--otlp-endpoint` parameter in `z2 join`:

```bash
z2 join --chain zq2-prototestnet --otlp-endpoint=http://localhost:4317
```

This integration demonstrates Zilliqa's commitment to providing robust monitoring capabilities that align with modern observability practices, enabling operators to maintain healthy and efficient network nodes.

## Local Testing

For local testing of the OpenTelemetry stack with the Zilliqa nodes, you can use the provided Docker Compose project in the `infra/opentelemetry` folder of the [zq2 repository](https://github.com/Zilliqa/zq2), and run:

```bash
docker-compose up -d
```

This will deploy a Zilliqa environment with the complete OpenTelemetry toolset and once deployed, the metrics can be visualized through Grafana at [http://localhost:9010](http://localhost:9010).
---
id: nodes/opentelemetry
title: OpenTelemetry
keywords:
- Node
- Validator
- Monitor
- OpenTelemetry
- Metrics
description: OpenTelemetry
---

# OpenTelemetry Metrics

[OpenTelemetry](https://opentelemetry.io/) is an open-source observability framework designed to generate, collect, and manage telemetry data (metrics, traces, and logs) in distributed systems. It provides a standardized way to instrument, generate, collect, and export telemetry data for analysis, making it easier to monitor and troubleshoot complex distributed applications.

## Integration with Zilliqa

A Zilliqa node contains various performance and operational metrics compatible with the OpenTelemetry protocol specification. These metrics are useful for:

- Monitoring node performance and health
- Understanding system behavior under different conditions
- Enabling proactive maintenance and troubleshooting

To export the OpenTelemetry metrics, you can define the collector endpoint with the `--otlp-endpoint` parameter in `z2 join`:

```bash
z2 join --chain zq2-prototestnet --otlp-endpoint=http://localhost:4317
```

This integration demonstrates Zilliqa's commitment to providing robust monitoring capabilities that align with modern observability practices, enabling operators to maintain healthy and efficient network nodes.

## Local Testing

For local testing of the OpenTelemetry stack with the Zilliqa nodes, you can use the provided Docker Compose project in the `infra/opentelemetry` folder of the [zq2 repository](https://github.com/Zilliqa/zq2), and run:

```bash
docker-compose up -d
```

This will deploy a Zilliqa environment with the complete OpenTelemetry toolset and once deployed, the metrics can be visualized through Grafana at [http://localhost:9010](http://localhost:9010).

0 comments on commit a87aa35

Please sign in to comment.