Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Weifeng Wang <qclaogui@gmail.com>
  • Loading branch information
qclaogui committed Apr 17, 2024
1 parent 969a1bf commit 74f5254
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 32 deletions.
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Once all containers are up and running you can search for metrics in Grafana. Na

> In this case you can find `github-exporter` metrics and logs.
For more examples, See: [examples/](./examples/)
More usage examples, See: [examples/](./examples/)

---

Expand All @@ -48,10 +48,6 @@ For more examples, See: [examples/](./examples/)
Usage:
make <target>

Lint & fmt
copyright Add Copyright header to .go files.
fmt Uses Grafana Agent to fmt the river config

Docker compose
up-monolithic-mode-metrics Run monolithic-mode Mimir for metrics
up-monolithic-mode-logs Run monolithic-mode Loki for logs
Expand Down Expand Up @@ -86,20 +82,11 @@ Kubernetes
deploy-microservices-mode-profiles Deploy microservices-mode Pyroscope for profiles
deploy-microservices-mode-traces Deploy microservices-mode Tempo for traces

Grafana Agent Integrations
deploy-mysql Deploy integration mysql manifests
deploy-redis Deploy integration redis manifests

Build
generate generate embed deps
build Build binary for current OS and place it at ./bin/lgtmp_$(GOOS)_$(GOARCH)
build-all Build binaries for Linux and Mac and place them in dist/

Release
prepare-release-candidate Create release candidate
prepare-release Create release
print-version Prints the upcoming release number

General
console-token Prints the minio-operator console jwt token
help Display this help. Thanks to https://www.thapaliya.com/en/writings/well-documented-makefiles/
Expand Down
5 changes: 5 additions & 0 deletions compose.override.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,21 @@ services:
metrics.grafana.com/scrape: true
profiles.grafana.com/service_name: grafana
profiles.grafana.com/port: 6060
image: ${GRAFANA_IMAGE:-docker.io/grafana/grafana:11.0.0-preview}
volumes:
- ./monitoring-mixins/loki-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/loki-mixin
- ./monitoring-mixins/tempo-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/tempo-mixin
- ./monitoring-mixins/mimir-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/mimir-mixin
- ./monitoring-mixins/pyroscope-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/pyroscope-mixin
- ./examples/grafana-explore-logs/grafana/provisioning/plugins/grafana-lokiexplore-app.yaml:/etc/grafana/provisioning/plugins/grafana-lokiexplore-app.yaml
environment:
GF_LOG_LEVEL: ${GF_LOG_LEVEL:-warn}
GF_DIAGNOSTICS_PROFILING_ENABLED: true
GF_DIAGNOSTICS_PROFILING_ADDR: 0.0.0.0
GF_DIAGNOSTICS_PROFILING_PORT: 6060
GF_FEATURE_TOGGLES_ENABLE: accessControlOnCall
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: grafana-lokiexplore-app
GF_INSTALL_PLUGINS: https://storage.googleapis.com/integration-artifacts/grafana-lokiexplore-app/grafana-lokiexplore-app-latest.zip;grafana-lokiexplore-app

# override compose.yaml included service tempo's labels and environment to enabled profiles and traces data collection
tempo:
Expand Down
5 changes: 3 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ This directory contains examples, including:
- [github-exporter-with-simple-dashboards](./ghe-with-simple-dashboards)
- [github-exporter](./github-exporter)
- [grafana-oncall-integration](./grafana-oncall)
- [grafana-explore-logs](./grafana-explore-logs)

## Debug info

`alloy` target Auto Scrape by [label](../docker-compose/common/config/alloy/modules/compose/README.md):
`alloy` target Label Scrape by [label](../alloy-modules/compose/README.md#compose-labels_scrape-component):

<http://localhost:12345/component/metrics.label_auto_scrape.default/prometheus.scrape.pc_docker_metrics>
<http://localhost:12345/component/metrics.labels_scrape.compose/prometheus.scrape.pc_docker_metrics>

## Grafana LGTMP Stack default port-mapping

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ apiVersion: 1
apps:
- type: grafana-lokiexplore-app
name: grafana-lokiexplore-app
disabled: false
org_id: 1
# org_name: "Main Org"
disabled: false
jsonData:
apiUrl: http://default-url.com
isApiKeySet: true
secureJsonData:
apiKey: secret-key
# jsonData:
# apiUrl: http://default-url.com
# isApiKeySet: true
# secureJsonData:
# apiKey: secret-key
12 changes: 7 additions & 5 deletions examples/grafana-oncall/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Developer-friendly incident response with brilliant Slack integration.

![oncall-alert-workflow](https://grafana.com/static/img/docs/oncall/oncall-alert-workflow.png)

> Add Grafana OnCall integration with monitoring system
## Docker `compose.yaml`

`compose.yaml`:
Expand Down Expand Up @@ -120,8 +118,8 @@ services:
environment:
GF_SECURITY_ADMIN_USER: oncall
GF_SECURITY_ADMIN_PASSWORD: oncall
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: grafana-oncall-app
GF_INSTALL_PLUGINS: grafana-oncall-app v1.3.115, redis-app v2.2.1
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: grafana-oncall-app, redis-app
GF_INSTALL_PLUGINS: grafana-oncall-app v1.4.3, redis-app v2.2.1
```

## Launch services
Expand All @@ -135,10 +133,14 @@ Once all containers are up and running you can search for metrics in Grafana.
> [!IMPORTANT]
> 😞 Grafana OnCall is available for authorized users only, please sign in to proceed. For this example login credentials: `oncall`/`oncall`.
Navigate to [http://localhost:3000](http://localhost:3000)
Navigate to <http://localhost:3000/a/grafana-oncall-app>.

## Stop services

```shell
COMPOSE_EXPERIMENTAL_GIT_REMOTE=true docker compose down
```

## Helpful Links

- <https://github.com/grafana/oncall>
10 changes: 5 additions & 5 deletions examples/grafana-oncall/compose.override.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ services:
# override included service grafana environment
grafana:
volumes:
- ./config/grafana/provisioning/plugins/grafana-oncall-app.yaml:/etc/grafana/provisioning/plugins/grafana-oncall-app.yaml
- ./config/grafana/provisioning/plugins/redis-app.yaml:/etc/grafana/provisioning/plugins/redis-app.yaml
- ./config/grafana/provisioning/datasources/redis.yaml:/etc/grafana/provisioning/datasources/redis.yaml
- ./grafana/provisioning/plugins/grafana-oncall-app.yaml:/etc/grafana/provisioning/plugins/grafana-oncall-app.yaml
- ./grafana/provisioning/plugins/redis-app.yaml:/etc/grafana/provisioning/plugins/redis-app.yaml
- ./grafana/provisioning/datasources/redis.yaml:/etc/grafana/provisioning/datasources/redis.yaml
environment:
GF_SECURITY_ADMIN_USER: oncall
GF_SECURITY_ADMIN_PASSWORD: oncall
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: grafana-oncall-app
GF_INSTALL_PLUGINS: grafana-oncall-app v1.4.0, redis-app v2.2.1
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: grafana-oncall-app, redis-app
GF_INSTALL_PLUGINS: grafana-oncall-app v1.4.3, redis-app v2.2.1

0 comments on commit 74f5254

Please sign in to comment.