Skip to content

Commit 657e416

Browse files
iohk-bors[bot]Denis Shevchenko
iohk-bors[bot]
and
Denis Shevchenko
authored
Merge #4175
4175: RTView: a link from tracer's README, quick start r=denisshevchenko a=denisshevchenko The first feedback from SPO: it's hard to find a link to RTView documentation. Now the link is in `cardano-tracer`'s README. Later (after official release) the similar link will be placed in `cardano-node`'s README as well. Also, I've added a Quick Start section for RTView. Co-authored-by: Denis Shevchenko <[email protected]>
2 parents 9c049c4 + b7559f6 commit 657e416

File tree

4 files changed

+101
-9
lines changed

4 files changed

+101
-9
lines changed

‎cardano-tracer/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44

55
For more details please [read the documentation](https://github.com/input-output-hk/cardano-node/blob/master/cardano-tracer/docs/cardano-tracer.md).
66

7+
## RTView
8+
9+
RTView is a real-time monitoring tool for Cardano nodes (RTView is an abbreviation for "Real Time View"), it is a part of `cardano-tracer` service. RTView provides an interactive web page where you can see different kinds of information about connected nodes (something like Grafana).
10+
11+
For more details please [read its documentation](https://github.com/input-output-hk/cardano-node/blob/master/cardano-tracer/docs/cardano-rtview.md).
12+
713
## Developers
814

915
Benchmarking team is responsible for this service. The primary developer is [@denisshevchenko](https://github.com/denisshevchenko).

‎cardano-tracer/configuration/minimal-example-rtview.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"networkMagic": 764824073,
3+
"network": {
4+
"tag": "AcceptAt",
5+
"contents": "/tmp/forwarder.sock"
6+
},
7+
"hasRTView": {
8+
"epHost": "127.0.0.1",
9+
"epPort": 3300
10+
},
11+
"logging": [
12+
{
13+
"logRoot": "/tmp/cardano-tracer-logs",
14+
"logMode": "FileMode",
15+
"logFormat": "ForMachine"
16+
}
17+
]
18+
}

‎cardano-tracer/configuration/minimal-example-rtview.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
networkMagic: 764824073
3+
network:
4+
tag: AcceptAt
5+
contents: "/tmp/forwarder.sock"
6+
hasRTView:
7+
epHost: 127.0.0.1
8+
epPort: 3300
9+
logging:
10+
- logRoot: "/tmp/cardano-tracer-logs"
11+
logMode: FileMode
12+
logFormat: ForMachine

‎cardano-tracer/docs/cardano-rtview.md

+65-9
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@ RTView is a part of `cardano-tracer` [service](https://github.com/input-output-h
55
# Contents
66

77
1. [Introduction](#Introduction)
8-
   1. [Motivation](#Motivation)
9-
   2. [Overview](#Overview)
10-
2. [Configuration](#Configuration)
11-
3. [Notifications](#Notifications)
12-
   1. [SMTP settings](#SMTP-settings)
13-
   2. [Note for Gmail users](#Note-for-Gmail-users)
14-
   3. [Events](#Events)
15-
   4. [Notify period](#Notify-period)
16-
4. [UI](#UI)
8+
1. [Motivation](#Motivation)
9+
2. [Overview](#Overview)
10+
2. [TL;DR: Quick Start](#TL;DR:-Quick-Start)
11+
3. [Configuration](#Configuration)
12+
4. [Notifications](#Notifications)
13+
1. [SMTP settings](#SMTP-settings)
14+
2. [Note for Gmail users](#Note-for-Gmail-users)
15+
3. [Events](#Events)
16+
4. [Notify period](#Notify-period)
17+
5. [UI](#UI)
1718
1. [Security Alert](#Security-Alert)
19+
2. [Missing Metrics](#Missing-Metrics)
1820

1921
# Introduction
2022

@@ -40,6 +42,51 @@ After your node connects to `cardano-tracer`, you'll see a column with different
4042

4143
Also, there are dynamic charts for different metrics, such as system metrics, blockchain metrics, transaction metrics, etc.
4244

45+
# TL;DR: Quick Start
46+
47+
If you just want to see what is RTView in action - all you need is following simple steps. For simplicity, it is assumed that `cardano-tracer` and your node will run on the same machine with Unix-like OS (for example, Linux).
48+
49+
## Tracer's Side
50+
51+
First of all, take configuration file `minimal-example-rtview.json` from `cardano-tracer/configuration` directory.
52+
53+
Next, run `cardano-tracer` with this configuration file like this:
54+
55+
```
56+
$ ./cardano-tracer -c minimal-example-rtview.json
57+
```
58+
59+
## Node's Side
60+
61+
Now, open your node's configuration file (if you took it from [Hydra](https://hydra.iohk.io/job/Cardano/cardano-node/cardano-deployment/latest-finished/download/1/index.html), it's `mainnet-config.json`) and add the following lines in it:
62+
63+
```
64+
"UseTraceDispatcher": true,
65+
"TraceOptions": {
66+
"": {
67+
"severity": "Notice",
68+
"detail": "DNormal",
69+
"backends": [
70+
"Stdout MachineFormat",
71+
"EKGBackend",
72+
"Forwarder"
73+
]
74+
}
75+
},
76+
"TraceOptionPeerFrequency": 2000,
77+
"TraceOptionResourceFrequency": 5000,
78+
"TurnOnLogMetrics": false,
79+
"TraceOptionNodeName": "relay-1"
80+
```
81+
82+
Finally, run the node with this configuration file and add tracer's CLI-parameter like this:
83+
84+
```
85+
$ ./cardano-node run --tracer-socket-path-connect /tmp/forwarder.sock
86+
```
87+
88+
That's it. Now you can open [https://127.0.0.1:3300](https://127.0.0.1:3300/) in your browser.
89+
4390
# Configuration
4491

4592
Since RTView is a part of `cardano-tracer`, the only thing you need to do is to enable RTView (because it's disabled by default). To do it, please add the following lines to `cardano-tracer`'s configuration file.
@@ -112,3 +159,12 @@ If you selected `Every 12 hours`, the new email with associated event(s) will be
112159
## Security Alert
113160

114161
When you open the web page for the first time, you'll see a warning from your browser, something like "Potential Security Risk Ahead" or "Your connection is not private". This is because `https`-connection between your browser and RTView is using [self-signed certificate](https://en.wikipedia.org/wiki/Self-signed_certificate) generated by [openssl](https://www.openssl.org/) program. So click to `Advanced` button and open the page. Technically, there is no risk at all - your connection **is** private.
162+
163+
## Missing Metrics
164+
165+
When the node connects to `cardano-tracer` and RTView's page displays the first data from it, you may see that some other data is missing: there is `—` instead of particular value. There are following possible reasons for it:
166+
167+
1. The node didn't provide corresponding metrics _yet_, because some information (for example, sync percent) can be displayed only after few minutes after node's start.
168+
2. The node _cannot_ provide corresponding metrics. For example, forging-related metrics make sense only for producer node, not for relay node.
169+
3. The node doesn't provide corresponding metrics because of node's configuration. For example, it can specify severity filter for particular metric, so it just filtered out.
170+
4. The node is incompatible with `cardano-tracer` (they were built from different branches of `cardano-node` repository). For example, particular metric may be renamed in the node, but `cardano-tracer` is still using outdated name.

0 commit comments

Comments
 (0)