Skip to content

Commit 94dc5b8

Browse files
committed
updates based on review
1 parent 53afeb5 commit 94dc5b8

6 files changed

Lines changed: 11 additions & 8 deletions

File tree

.github/workflows/go-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
steps:
1515
- uses: actions/checkout@v4
1616
with:
17-
fetch-depth: 0 # Get tags to allow build script to get build version
17+
fetch-depth: 0 # Get tags to allow the build script to get a build version
1818

1919
- name: Set up Go
2020
uses: actions/setup-go@v5

.github/workflows/golangci-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
steps:
1515
- uses: actions/checkout@v4
1616
with:
17-
fetch-depth: 0 # Get tags to allow build script to get build version
17+
fetch-depth: 0 # Get tags to allow the build script to get a build version
1818

1919
- name: Set up Go
2020
uses: actions/setup-go@v5

.github/workflows/release.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ jobs:
1212
steps:
1313
- uses: actions/checkout@v4
1414
with:
15-
fetch-depth: 0 # Get tags to allow build script to get build version
15+
ref: ${{ github.ref }} # Checkout the specified tag
16+
fetch-depth: 0 # Get tags to allow the build script to get a build version
1617

1718
- name: Set up Go
1819
uses: actions/setup-go@v5

telemetry-demo/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Run a continuous scan (every 2 seconds):
3434
Or run a single one-off scan:
3535
```bash
3636
echo 'file=056f9b95f439d915bd3d81ceee9ccf9a,1234,test.js' | curl -s -X POST 'http://localhost:5443/scan/direct' -F 'file=@-;filename=test.wfp'
37-
````
37+
```
3838

3939
## Visualisation
4040
The complete observability stack is configured to export metrics, logs, and traces. This can all be visualised in Grafana.
41-
To logins to Grafana, please browse the following URL:
41+
To login to Grafana, please browse the following URL:
4242
- http://localhost:3000
4343
- No username/password required
4444

@@ -64,8 +64,8 @@ To view traces, please browse the following URL:
6464
#### Option 1: Grafana (Advanced Dashboards)
6565
1. **URL**: http://localhost:3000/a/grafana-metricsdrilldown-app/drilldown
6666
2. Select "prometheus" from the "Data Source" dropdown
67-
3.Type `scanoss` into the "Search metric" field to list all SCANOSS metrics
68-
3. Select an appropriate time window
67+
3. Type `scanoss` into the "Search metric" field to list all SCANOSS metrics
68+
4. Select an appropriate time window
6969

7070
#### Option 2: Prometheus UI (Built-in, Simple)
7171
- **URL**: http://localhost:9090
@@ -141,7 +141,7 @@ After exploring this demo, configure telemetry for your production API using [TE
141141
| `promtail-config.yml` | Configures Promtail log Collector pipeline |
142142
| `loki.yaml` | Defines Loki logging setup |
143143
| `prometheus.yml` | Defines Prometheus scrape targets |
144-
| `tempo.yml` | Defines Temop traces setup |
144+
| `tempo.yml` | Defines Tempo traces setup |
145145
| `grafana-datasources.yaml` | Data source configuration for Grafana |
146146
| `config/app-config-demo.json` | API configuration with telemetry enabled |
147147
| `TELEMETRY_CONFIG.md` | Production telemetry configuration guide |

telemetry-demo/docker-compose.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,13 @@ services:
6060
- prometheus_data:/prometheus
6161
command:
6262
- '--config.file=/etc/prometheus/prometheus.yml'
63+
- '--web.enable-remote-write-receiver'
6364
- '--storage.tsdb.path=/prometheus'
6465
- '--web.console.libraries=/etc/prometheus/console_libraries'
6566
- '--web.console.templates=/etc/prometheus/consoles'
6667
- '--storage.tsdb.retention.time=200h'
6768
- '--web.enable-lifecycle'
69+
- '--enable-feature=exemplar-storage'
6870
networks:
6971
- monitoring
7072
restart: unless-stopped
File renamed without changes.

0 commit comments

Comments
 (0)