Skip to content

Commit a75ba85

Browse files
author
MariusBrill
committed
Update Readme
(cherry picked from commit 89e371d)
1 parent f7e9c7f commit a75ba85

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ After activating the Dummy Data your Data Mapping should look like this:
6161
| Error Rate (Outgoing) | error_out |
6262
| Response Time Baseline (Upper) | threshold |
6363

64+
6465
_Note that you may have to refresh the dashboard or reload the page in order for it to work._
6566

6667
##### Live example dummy data
@@ -73,8 +74,6 @@ ___
7374

7475
If you now want to use your own data source you have make sure, that the data received is in the `TABLE` format and is structured as follows:
7576

76-
* The table requires a column which is named equal to the value of the `aggregationType` settings field. This column defines the component to which the data refers to.
77-
**Example**: Assuming the `aggregationType` variable is set to `app`, the data table has to provide a column named `app`.
7877
* The table requires at least one column which specifies the connection's source or target. The settings `Source Component Column` and `Target Component Column` need to be set to the exact namings of the respective fields.
7978

8079
* The data can contain multiple value columns. These columns have to be mapped on specifc attributes using the panel's `Data Mappings` options.
@@ -92,14 +91,12 @@ If the previously described requirements are respected, a minimal table can be a
9291
| service a | service c | 75 |
9392
| service c | service d | 25 |
9493

95-
Assuming a `aggregationType` variable is provided and set to `app` and the panel's settings are specified as seen in the screenshot, the panel will visualize the data as following:
94+
Assuming the panel's settings are specified as seen in the screenshot, the panel will visualize the data as following:
9695

9796
![Visualization of the minimal data table.](https://raw.githubusercontent.com/NovatecConsulting/novatec-service-dependency-graph-panel/master/src/img/data-example-1.png)
9897

9998
> Note: It is important to know that connections can only be generated if at least one request-rate column (incoming or outgoing) is defined.
10099
101-
The data mapping represents always the data from the point of view of the component which is specified by the column which name is equal to the `aggregationType` variable. This means that if we want to represent an outgoing connection in this example, the `app` and `target_app` columns must be present. In case an incoming connection should be represented, the `app` and `origin_app` columns must be present.
102-
103100
##### Example 2
104101

105102
In this example, we extend the data table of example 1 by another column, representing the total sum of all request response times of a specific connection (e.g. sum of all HTTP request response times).
@@ -174,5 +171,4 @@ release-it [--no-git.requireCleanWorkingDir]
174171

175172
### Found a bug? Have a question? Wanting to contribute?
176173

177-
Feel free to open up an issue. We will take care of you and provide as much help as needed. Any suggestions/contributions are being very much appreciated.
178-
174+
Feel free to open up an issue. We will take care of you and provide as much help as needed. Any suggestions/contributions are being very much appreciated.

0 commit comments

Comments
 (0)