Skip to content

Commit 4118ffa

Browse files
committed
docs: Move observability. Add external links. Fix admonitions
1 parent bbec7f6 commit 4118ffa

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

docs/overview/Natural Language Processing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Please see [CogStack using Apache NiFi Deployment Examples](https://github.com/C
173173

174174
Assuming that the application is running on the `localhost` with the API exposed on port `5000`, one can run:
175175

176-
```java
176+
```bash
177177
curl -XPOST http://localhost:5000/api/process \
178178
-H 'Content-Type: application/json' \
179179
-d '{"content":{"text":"The patient was diagnosed with leukemia."}}'
@@ -182,7 +182,7 @@ curl -XPOST http://localhost:5000/api/process \
182182

183183
and the received result:
184184

185-
```java
185+
```json
186186
{
187187
"result": {
188188
"text": "The patient was diagnosed with leukemia.",
@@ -211,7 +211,7 @@ and the received result:
211211

212212
Bio-YODIE is being run as a service using CogStack GATE NLP Runner Service as described above. In this example Bio-YODIE application will only output annotations of `Disease` type from `Bio` group (defined in the service configuration file). Assuming that the service is running on the `localhost` with the API exposed on port `8095`, so one can run:
213213

214-
```java
214+
```bash
215215
curl --header "Content-Type: application/json" \
216216
--request POST \
217217
--data '{"content":{"text": "lung cancer diagnosis"}}' \
@@ -220,7 +220,7 @@ curl --header "Content-Type: application/json" \
220220

221221
and the received result:
222222

223-
```java
223+
```json
224224
{
225225
"result": {
226226
"text": "lung cancer diagnosis",
@@ -270,7 +270,7 @@ As an extra example, a simple application for extracting drug names from the fre
270270

271271
Similarly as in above, assuming that the application is running on the `localhost` with the API exposed on port `8095`, one can run:
272272

273-
```java
273+
```bash
274274
curl -XPOST http://localhost:8095/api/process \
275275
-H 'Content-Type: application/json' \
276276
-d '{"content":{"text":"The patient was prescribed with Aspirin."}}'
@@ -279,7 +279,7 @@ curl -XPOST http://localhost:8095/api/process \
279279

280280
and the received result:
281281

282-
```java
282+
```json
283283
{
284284
"result": {
285285
"text": "The patient was prescribed with Aspirin.",

docs/platform/observability/reference/quickstart-manual.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ mkdir -p observability-simple/alloy/probers
1111

1212
Download these two files, and place in the right folder
1313

14-
- [docker-compose.yml](../../../observability/examples/simple/docker-compose.yml) in observability-simple/
15-
- [probe-observability.yml](../../../observability/examples/simple/alloy/probers/probe-observability.yml) into observability-simple/alloy/probers
14+
- [docker-compose.yml](../../../../observability/examples/simple/docker-compose.yml) in observability-simple/
15+
- [probe-observability.yml](../../../../observability/examples/simple/alloy/probers/probe-observability.yml) into observability-simple/alloy/probers
1616

1717
### Step 2: Start the stack
1818

docs/platform/observability/setup/production-setup.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ This script will setup all the folder structure, and download all the relevant f
2626
The script automates making folders, and downloading these files:
2727

2828
Downloads the example docker compose files:
29-
- [docker-compose.yml](../../../observability/examples/full/docker-compose.yml)
30-
- [exporters.docker-compose.yml](../../../observability/examples/full/exporters.docker-compose.yml)
31-
- [exporters.elastic.docker-compose.yml](../../../observability/examples/full/exporters.elastic.docker-compose.yml)
29+
- [docker-compose.yml](../../../../observability/examples/full/docker-compose.yml)
30+
- [exporters.docker-compose.yml](../../../../observability/examples/full/exporters.docker-compose.yml)
31+
- [exporters.elastic.docker-compose.yml](../../../../observability/examples/full/exporters.elastic.docker-compose.yml)
3232

3333
Downloads the configurations:
34-
- [alloy/probers/probe-external.yml](../../../observability/examples/full/alloy/probers/probe-external.yml)
35-
- [alloy/probers/probe-observability.yml ](../../../observability/examples/full/alloy/probers/probe-observability.yml)
36-
- [prometheus/scrape-configs/exporters/exporters.yml](../../../observability/examples/full/prometheus/scrape-configs/exporters/exporters.yml)
37-
- [prometheus/scrape-configs/recording-rules/slo.yml](../../../observability/examples/full/prometheus/scrape-configs/recording-rules/slo.yml)
34+
- [alloy/probers/probe-external.yml](../../../../observability/examples/full/alloy/probers/probe-external.yml)
35+
- [alloy/probers/probe-observability.yml ](../../../../observability/examples/full/alloy/probers/probe-observability.yml)
36+
- [prometheus/scrape-configs/exporters/exporters.yml](../../../../observability/examples/full/prometheus/scrape-configs/exporters/exporters.yml)
37+
- [prometheus/scrape-configs/recording-rules/slo.yml](../../../../observability/examples/full/prometheus/scrape-configs/recording-rules/slo.yml)
3838

3939

4040

@@ -86,7 +86,7 @@ This is probably the hardest step: You will actually need to know what is runnin
8686
## Step 5: Run Grafana Alloy on every VM
8787
The Grafana Alloy image needs to be run on each VM that you want to get information from.
8888

89-
Use the example docker compose file in [exporters.docker-compose.yml](../../../observability/examples/full/exporters.docker-compose.yml) which will start up alloy and get metrics
89+
Use the example docker compose file in [exporters.docker-compose.yml](../../../../observability/examples/full/exporters.docker-compose.yml) which will start up alloy and get metrics
9090

9191
```
9292
docker compose -f exporters.docker-compose.yml up -d

docs/platform/observability/setup/telemetry.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We have to run Grafana Alloy on every single VM to get telemetry.
1616

1717
Alloy is setup to push metrics to a central prometheus instance.
1818

19-
- Copy this docker compose file: [exporters.docker-compose.yml](../../../observability/examples/full/exporters.docker-compose.yml)
19+
- Copy this docker compose file: [exporters.docker-compose.yml](../../../../observability/examples/full/exporters.docker-compose.yml)
2020
- Edit the environment variables to point to your prometheus URL:
2121

2222
```yaml
@@ -34,8 +34,8 @@ Now you have the setup, you will have to run this on every VM you want metrics f
3434
### Elastic Search Metrics
3535
To get elasticsearch metrics we have to mount an alloy config file into the image.
3636

37-
- Copy this docker compose file: [exporters.elastic.docker-compose.yml](../../../observability/examples/full/exporters.elastic.docker-compose.yml)
38-
- Copy this configuration file [elasticsearch.alloy](../../../observability/examples/full/alloy/elasticsearch.alloy) into `alloy/elasticsearch.alloy`
37+
- Copy this docker compose file: [exporters.elastic.docker-compose.yml](../../../../observability/examples/full/exporters.elastic.docker-compose.yml)
38+
- Copy this configuration file [elasticsearch.alloy](../../../../observability/examples/full/alloy/elasticsearch.alloy) into `alloy/elasticsearch.alloy`
3939

4040
In the docker compose file, we can see there are two changes to the usual exporter:
4141

0 commit comments

Comments
 (0)