Skip to content

Commit

Permalink
Grafana correction in caliper documentation (#1574)
Browse files Browse the repository at this point in the history
* Update ResourceAndTransactionMonitors.md

Signed-off-by: Vivek jha <85884487+duckling69@users.noreply.github.com>

* Update ResourceAndTransactionMonitors.md

Signed-off-by: Vivek jha <85884487+duckling69@users.noreply.github.com>

---------

Signed-off-by: Vivek jha <85884487+duckling69@users.noreply.github.com>
  • Loading branch information
duckling69 authored May 14, 2024
1 parent 3df0c34 commit 5f333fd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 32 deletions.
22 changes: 6 additions & 16 deletions docs/v0.6.0/ResourceAndTransactionMonitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,12 @@ The `prometheus` transaction module is used to expose current transaction statis
- caliper_tx_finished (counter)
- caliper_tx_e2e_latency (histogram)

Each of the above are tagged with the following default labels:

- roundLabel: the current test round label
- roundIndex: the current test round index
- workerIndex: the zero based worker index that is sending the information

The following specifies the use of a `prometheus` transaction module that exposes metrics for collection on the default port (3000) and the default scrape URL (`/metrics`).

```yaml
Expand Down Expand Up @@ -282,22 +288,6 @@ It is possible to use a Prometheus Push Gateway that is secured via basic authen

These will be used to augment the configuration file based URL prior to making a connection.

### Grafana Visualization

Grafana is an analytics platform that may be used to query and visualize metrics collected by Prometheus. Caliper clients make the following metrics available, either via a direct scrape or indirectly via a Prometheus Push Gateway:

- caliper_tx_submitted (counter)
- caliper_tx_finished (counter)
- caliper_tx_e2e_latency (histogram)

Each of the above are tagged with the following default labels:

- roundLabel: the current test round label
- roundIndex: the current test round index
- workerIndex: the zero based worker index that is sending the information

We are currently working on a Grafana dashboard to give you immediate access to the metrics published above, but in the interim please feel free to create custom queries to view the above metrics that are accessible in real time.

## Resource Charting

The data from each monitor is capable of being output in chart form within the generated Caliper report, via an option within the benchmark configuration file for each monitor. In addition to tabulated data for resource monitors, Caliper currently supports rendering of the following charts using `charting.js`:
Expand Down
22 changes: 6 additions & 16 deletions docs/vNext/ResourceAndTransactionMonitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,12 @@ The `prometheus` transaction module is used to expose current transaction statis
- caliper_tx_finished (counter)
- caliper_tx_e2e_latency (histogram)

Each of the above are tagged with the following default labels:

- roundLabel: the current test round label
- roundIndex: the current test round index
- workerIndex: the zero based worker index that is sending the information

The following specifies the use of a `prometheus` transaction module that exposes metrics for collection on the default port (3000) and the default scrape URL (`/metrics`).

```yaml
Expand Down Expand Up @@ -282,22 +288,6 @@ It is possible to use a Prometheus Push Gateway that is secured via basic authen

These will be used to augment the configuration file based URL prior to making a connection.

### Grafana Visualization

Grafana is an analytics platform that may be used to query and visualize metrics collected by Prometheus. Caliper clients make the following metrics available, either via a direct scrape or indirectly via a Prometheus Push Gateway:

- caliper_tx_submitted (counter)
- caliper_tx_finished (counter)
- caliper_tx_e2e_latency (histogram)

Each of the above are tagged with the following default labels:

- roundLabel: the current test round label
- roundIndex: the current test round index
- workerIndex: the zero based worker index that is sending the information

We are currently working on a Grafana dashboard to give you immediate access to the metrics published above, but in the interim please feel free to create custom queries to view the above metrics that are accessible in real time.

## Resource Charting

The data from each monitor is capable of being output in chart form within the generated Caliper report, via an option within the benchmark configuration file for each monitor. In addition to tabulated data for resource monitors, Caliper currently supports rendering of the following charts using `charting.js`:
Expand Down

0 comments on commit 5f333fd

Please sign in to comment.