You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dist/README.md
+23-11Lines changed: 23 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,19 @@
6
6
7
7

8
8
9
+
10
+
11
+
**Version 4.0.0 is only compatible with Grafana from version 7.1.0!**
12
+
13
+
14
+
9
15
The Service Dependency Graph Panel by [Novatec](https://www.novatec-gmbh.de/en/) provides you with many features such as monitoring
10
16
your latencies, errors and requests of your desired service. This interactive panel for [Grafana](https://grafana.com/) will help you
11
17
visualize the processes of your application much better.
12
18
13
-
___
14
-
### How to build
15
-
16
-
Due to dependency issues please install, if needed with `yarn install`
17
19
18
-
To build a production build with minification: `yarn build`
19
-
20
-
Run the following for hot-reloading during development: `yarn watch`
20
+
### Updating the Service Dependency Graph Panel
21
+
The file structure for the icon mapping has changed for version 4.0.0. **Icons are now located in the path 'plugins/novatec-sdg-panel/assets/icons/'.** This also applies to custom icons!
21
22
22
23
___
23
24
@@ -115,7 +116,7 @@ Now, the panel's `Data Mappings` option `Response Time Column` is set to `resp_t
115
116
116
117
___
117
118
118
-
###Service Icons
119
+
## Service Icons
119
120
120
121
The service dependency graph plugin allows you to display your own symbols in the drawn nodes.
121
122
For this purpose the option 'Service Icon Mapping' can be used.
@@ -131,9 +132,9 @@ This means that all nodes which have `java` in their name get the `java` icon.
131
132
132
133
#### Custom Service Icons
133
134
134
-
You can add custom icons, by putting them into the plugin's `/assets/service_icons/` directory.
135
+
You can add custom icons, by putting them into the plugin's `/assets/icons/` directory.
135
136
The file type **has to be `PNG`** and the icon itself and **has to be square**.
136
-
In order to be able to use the icon, its name (without its ending) has to be put into the array contained in the `icon_index.json` file located in the `/assets/service_icons/` directory.
137
+
In order to be able to use the icon, its name (without its ending) has to be put into the array contained in the `icon_index.json` file located in the `/assets/icons/` directory.
137
138
138
139
##### Example
139
140
@@ -143,7 +144,7 @@ If the `icon_index.json` has the following content:
143
144
["java", "star_trek"]
144
145
```
145
146
146
-
it is assumed that the files `java.png` and `star_trek.png` is existing in the `/assets/service_icons/` directory.
147
+
it is assumed that the files `java.png` and `star_trek.png` is existing in the `/assets/icons/` directory.
147
148
___
148
149
149
150
### Tracing Drilldown
@@ -160,6 +161,17 @@ The curly brackets `{}` will be replaced with the selected node.
160
161
161
162
___
162
163
164
+
## Create a Release
165
+
166
+
To create a release bundle, ensure `release-it` is installed:
167
+
```
168
+
npm install --global release-it
169
+
```
170
+
To build a release bundle:
171
+
```
172
+
release-it [--no-git.requireCleanWorkingDir]
173
+
```
174
+
163
175
### Found a bug? Have a question? Wanting to contribute?
164
176
165
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.
0 commit comments