Update README.md

Signed-off-by: Weifeng Wang <[email protected]>
acester822 · Apr 15, 2024 · c966884 · c966884
1 parent 024d3b8
commit c966884
Show file tree

Hide file tree

Showing 42 changed files with 133 additions and 124 deletions.
diff --git a/compose.override.yaml b/compose.override.yaml
@@ -32,9 +32,10 @@ services:
       profiles.grafana.com/service_name: grafana
       profiles.grafana.com/port: 6060
     volumes:
-      - ./monitoring-mixins/pyroscope-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/pyroscope-mixin
       - ./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
     environment:
       GF_LOG_LEVEL: ${GF_LOG_LEVEL:-warn}
       GF_DIAGNOSTICS_PROFILING_ENABLED: true
@@ -69,10 +70,11 @@ services:
     volumes:
       - ./monitoring-mixins/loki-mixin/deploy/loki-mixin-rules.yaml:/rules/loki-mixin-rules.yaml
       - ./monitoring-mixins/loki-mixin/deploy/loki-mixin-alerts.yaml:/rules/loki-mixin-alerts.yaml
-      - ./monitoring-mixins/pyroscope-mixin/deploy/pyroscope-mixin-rules.yaml:/rules/pyroscope-mixin-rules.yaml
       - ./monitoring-mixins/tempo-mixin/deploy/tempo-mixin-rules.yaml:/rules/tempo-mixin-rules.yaml
       - ./monitoring-mixins/tempo-mixin/deploy/tempo-mixin-alerts.yaml:/rules/tempo-mixin-alerts.yaml
-
+      - ./monitoring-mixins/mimir-mixin/deploy/mimir-mixin-rules.yaml:/rules/mimir-mixin-rules.yaml
+      - ./monitoring-mixins/mimir-mixin/deploy/mimir-mixin-alerts.yaml:/rules/mimir-mixin-alerts.yaml
+      - ./monitoring-mixins/pyroscope-mixin/deploy/pyroscope-mixin-rules.yaml:/rules/pyroscope-mixin-rules.yaml
   # override compose.yaml included service pyroscope's labels and environment to enabled traces data collection
   pyroscope:
     labels:

diff --git a/docker-compose/common/compose-include/grafana.yaml b/docker-compose/common/compose-include/grafana.yaml
@@ -28,9 +28,8 @@ services:
       - ../config/grafana/dashboards:/var/lib/grafana/dashboards
       - ../config/grafana/provisioning:/etc/grafana/provisioning
       - ../../../monitoring-mixins/alloy-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/alloy-mixin
-      - ../../../monitoring-mixins/go-runtime-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/go-runtime-mixin
-      - ../../../monitoring-mixins/mimir-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/mimir-mixin
       - ../../../monitoring-mixins/memcached-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/memcached-mixin
+      - ../../../monitoring-mixins/go-runtime-mixin/deploy/dashboards_out:/var/lib/grafana/dashboards/go-runtime-mixin
     environment:
       GF_FEATURE_TOGGLES_ENABLE: traceqlEditor tracesEmbeddedFlameGraph traceqlSearch correlations metricsSummary traceToMetrics traceToProfiles
       GF_SMTP_ENABLED: true

diff --git a/docker-compose/common/compose-include/mimir.yaml b/docker-compose/common/compose-include/mimir.yaml
@@ -32,8 +32,6 @@ services:
       - ../../../monitoring-mixins/crontab:/etc/crontabs/root
       - ../../../monitoring-mixins/alloy-mixin/deploy/alloy-mixin-alerts.yaml:/rules/alloy-mixin-alerts.yaml
       - ../../../monitoring-mixins/memcached-mixin/deploy/memcached-mixin-alerts.yaml:/rules/memcached-mixin-alerts.yaml
-      - ../../../monitoring-mixins/mimir-mixin/deploy/mimir-mixin-rules.yaml:/rules/mimir-mixin-rules.yaml
-      - ../../../monitoring-mixins/mimir-mixin/deploy/mimir-mixin-alerts.yaml:/rules/mimir-mixin-alerts.yaml
     environment:
       - MIMIR_ADDRESS=http://gateway:8080
       - MIMIR_TENANT_ID=anonymous

diff --git a/docker-compose/common/compose-include/tempo.yaml b/docker-compose/common/compose-include/tempo.yaml
@@ -16,7 +16,6 @@ services:
       interval: 2s
       timeout: 1s
       retries: 15
-      # start_period: 10s
     # expose 33200 port so we can directly access tempo inside container
     ports:
       - "33200:3200"
diff --git a/docker-compose/common/config/alloy/all-in-one.alloy b/docker-compose/common/config/alloy/all-in-one.alloy
@@ -11,7 +11,7 @@ import.file "provider" {
 }
 
 // get self hosted receivers provider
-provider.self_hosted "compose" {
+provider.self_hosted_stack "compose" {
 	logs_endpoint_url     = "http://gateway:3100/loki/api/v1/push"
 	metrics_endpoint_url  = "http://gateway:8080/api/v1/push"
 	traces_endpoint_url   = "http://gateway:4318"
@@ -27,17 +27,17 @@ import.file "metrics" {
 
 metrics.labels_scrape "all" {
 	label_prefix    = "metrics.grafana.com"
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.jobs_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.integrations_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
@@ -55,7 +55,7 @@ logs.labels_scrape "all" {
 
 // logs Processing And Transformation
 logs.keep_labels "default" {
-	forward_to = [provider.self_hosted.compose.logs_receiver]
+	forward_to = [provider.self_hosted_stack.compose.logs_receiver]
 }
 
 /********************************************
@@ -67,9 +67,9 @@ import.file "traces" {
 
 // traces Processing And Transformation
 traces.pat "all" {
-	metrics_forward_to = [provider.self_hosted.compose.metrics_receiver]
-	logs_forward_to    = [provider.self_hosted.compose.logs_receiver]
-	traces_forward_to  = [provider.self_hosted.compose.traces_receiver]
+	metrics_forward_to = [provider.self_hosted_stack.compose.metrics_receiver]
+	logs_forward_to    = [provider.self_hosted_stack.compose.logs_receiver]
+	traces_forward_to  = [provider.self_hosted_stack.compose.traces_receiver]
 }
 
 tracing {
@@ -89,5 +89,5 @@ import.file "profiles" {
 
 profiles.labels_scrape "all" {
 	label_prefix = "profiles.grafana.com"
-	forward_to   = [provider.self_hosted.compose.profiles_receiver]
+	forward_to   = [provider.self_hosted_stack.compose.profiles_receiver]
 }
diff --git a/docker-compose/common/config/alloy/logs.alloy b/docker-compose/common/config/alloy/logs.alloy
@@ -11,7 +11,7 @@ import.file "provider" {
 }
 
 // get lgtmp receivers provider
-provider.self_hosted "compose" {
+provider.self_hosted_stack "compose" {
 	logs_endpoint_url    = "http://gateway:3100/loki/api/v1/push"
 	metrics_endpoint_url = "http://gateway:8080/api/v1/push"
 }
@@ -30,7 +30,7 @@ logs.labels_scrape "all" {
 
 // logs Processing And Transformation
 logs.keep_labels "default" {
-	forward_to = [provider.self_hosted.compose.logs_receiver]
+	forward_to = [provider.self_hosted_stack.compose.logs_receiver]
 }
 
 /********************************************
@@ -42,16 +42,16 @@ import.file "metrics" {
 
 metrics.labels_scrape "all" {
 	label_prefix    = "metrics.grafana.com"
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.jobs_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.integrations_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
diff --git a/docker-compose/common/config/alloy/metrics.alloy b/docker-compose/common/config/alloy/metrics.alloy
@@ -11,7 +11,7 @@ import.file "provider" {
 }
 
 // get lgtmp receivers provider
-provider.self_hosted "compose" {
+provider.self_hosted_stack "compose" {
 	metrics_endpoint_url = "http://gateway:8080/api/v1/push"
 }
 
@@ -24,16 +24,16 @@ import.file "metrics" {
 
 metrics.labels_scrape "all" {
 	label_prefix    = "metrics.grafana.com"
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.jobs_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.integrations_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
diff --git a/docker-compose/common/config/alloy/modules/provider/README.md b/docker-compose/common/config/alloy/modules/provider/README.md
@@ -4,10 +4,10 @@ Provide the receivers of the collected data(`logs` `metrics` `traces` `profiles`
 
 ## Components
 
-- [self_hosted](#self_hosted)
+- [self_hosted_stack](#self_hosted_stack)
 - [grafana_cloud](#grafana_cloud)
 
-### `self_hosted`
+### `self_hosted_stack`
 
 Module to configure receivers for Self Hosted LGTMP Stack.
 
@@ -40,12 +40,12 @@ import.git "provider" {
 }
 
 // get the receivers from provider
-provider.self_hosted "compose" {
+provider.self_hosted_stack "compose" {
   metrics_endpoint_url  = "http://mimir:8080/api/v1/push"
 }
 
 // get the receivers from provider
-provider.self_hosted "kubernetes" {
+provider.self_hosted_stack "kubernetes" {
   metrics_endpoint_url  = "http://mimir.monitoring-system.svc.cluster.local:8080/api/v1/push"
 }
 
@@ -56,8 +56,8 @@ prometheus.scrape "default" {
   ]
 
   forward_to = [
-    provider.self_hosted.compose.metrics_receiver,
-    provider.self_hosted.kubernetes.metrics_receiver,
+    provider.self_hosted_stack.compose.metrics_receiver,
+    provider.self_hosted_stack.kubernetes.metrics_receiver,
   ]
 }
 ```

diff --git a/docker-compose/common/config/alloy/modules/provider/self_hosted.alloy b/docker-compose/common/config/alloy/modules/provider/self_hosted.alloy
@@ -1,9 +1,9 @@
 /************************************************
-* Component: self_hosted
+* Component: self_hosted_stack
 * Description: Self Hosteded Receiver Provider
 *************************************************/
 
-declare "self_hosted" {
+declare "self_hosted_stack" {
 
 	/********************************************
 	* ARGUMENTS

diff --git a/docker-compose/common/config/alloy/profiles.alloy b/docker-compose/common/config/alloy/profiles.alloy
@@ -11,7 +11,7 @@ import.file "provider" {
 }
 
 // get lgtmp receivers provider
-provider.self_hosted "compose" {
+provider.self_hosted_stack "compose" {
 	metrics_endpoint_url  = "http://gateway:8080/api/v1/push"
 	profiles_endpoint_url = "http://gateway:4040"
 }
@@ -25,7 +25,7 @@ import.file "profiles" {
 
 profiles.labels_scrape "all" {
 	label_prefix = "profiles.grafana.com"
-	forward_to   = [provider.self_hosted.compose.profiles_receiver]
+	forward_to   = [provider.self_hosted_stack.compose.profiles_receiver]
 }
 
 /********************************************
@@ -37,16 +37,16 @@ import.file "metrics" {
 
 metrics.labels_scrape "all" {
 	label_prefix    = "metrics.grafana.com"
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.jobs_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.integrations_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
diff --git a/docker-compose/common/config/alloy/traces.alloy b/docker-compose/common/config/alloy/traces.alloy
@@ -11,7 +11,7 @@ import.file "provider" {
 }
 
 // get lgtmp receivers provider
-provider.self_hosted "compose" {
+provider.self_hosted_stack "compose" {
 	logs_endpoint_url    = "http://gateway:3100/loki/api/v1/push"
 	metrics_endpoint_url = "http://gateway:8080/api/v1/push"
 	traces_endpoint_url  = "http://gateway:4318"
@@ -26,9 +26,9 @@ import.file "traces" {
 
 // traces Processing And Transformation
 traces.pat "all" {
-	metrics_forward_to = [provider.self_hosted.compose.metrics_receiver]
-	logs_forward_to    = [provider.self_hosted.compose.logs_receiver]
-	traces_forward_to  = [provider.self_hosted.compose.traces_receiver]
+	metrics_forward_to = [provider.self_hosted_stack.compose.metrics_receiver]
+	logs_forward_to    = [provider.self_hosted_stack.compose.logs_receiver]
+	traces_forward_to  = [provider.self_hosted_stack.compose.traces_receiver]
 }
 
 tracing {
@@ -48,16 +48,16 @@ import.file "metrics" {
 
 metrics.labels_scrape "all" {
 	label_prefix    = "metrics.grafana.com"
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.jobs_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
 
 metrics.integrations_scrape "all" {
-	forward_to      = [provider.self_hosted.compose.metrics_receiver]
+	forward_to      = [provider.self_hosted_stack.compose.metrics_receiver]
 	scrape_interval = "15s"
 }
diff --git a/docker-compose/microservices-mode/logs/README.md b/docker-compose/microservices-mode/logs/README.md
@@ -27,8 +27,8 @@ flowchart LR
     subgraph Minio
         M{"Object Storage"}
     end
-    subgraph Agent["Grafana Agent"]
-        A("agent")
+    subgraph Agent["Grafana Alloy"]
+        A("alloy")
     end
     subgraph Grafana
         G("grafana")

diff --git a/docker-compose/microservices-mode/logs/compose.yaml b/docker-compose/microservices-mode/logs/compose.yaml
@@ -21,7 +21,7 @@ x-labels: &loki-labels
 # Configure a check that's run to determine whether or not containers for this service are "healthy".
 # docs: https://docs.docker.com/compose/compose-file/compose-file-v3/#healthcheck
 x-healthcheck: &status-healthcheck
-  interval: 3s
+  interval: 5s
   timeout: 2s
   retries: 10
 

diff --git a/docker-compose/microservices-mode/metrics/README.md b/docker-compose/microservices-mode/metrics/README.md
@@ -33,8 +33,8 @@ flowchart LR
     subgraph Minio
         M{"Object Storage"}
     end
-    subgraph Agent["Grafana Agent"]
-        A("agent")
+    subgraph Agent["Grafana Alloy"]
+        A("alloy")
     end
     subgraph Grafana
         G("grafana")

diff --git a/docker-compose/microservices-mode/metrics/compose.yaml b/docker-compose/microservices-mode/metrics/compose.yaml
@@ -15,7 +15,7 @@ include:
 # Configure a check that's run to determine whether or not containers for this service are "healthy".
 # docs: https://docs.docker.com/compose/compose-file/compose-file-v3/#healthcheck
 x-healthcheck: &status-healthcheck
-  interval: 3s
+  interval: 5s
   timeout: 2s
   retries: 10
 

diff --git a/docker-compose/microservices-mode/profiles/README.md b/docker-compose/microservices-mode/profiles/README.md
@@ -17,8 +17,8 @@ flowchart LR
         M{"Object Storage"}
     end
 
-    subgraph Agent["Grafana Agent"]
-        A("agent")
+    subgraph Agent["Grafana Alloy"]
+        A("alloy")
     end
     subgraph Grafana
         G("grafana")

diff --git a/docker-compose/microservices-mode/profiles/compose.yaml b/docker-compose/microservices-mode/profiles/compose.yaml
@@ -23,7 +23,7 @@ x-labels: &profiles-labels
 # Configure a check that's run to determine whether or not containers for this service are "healthy".
 # docs: https://docs.docker.com/compose/compose-file/compose-file-v3/#healthcheck
 x-healthcheck: &status-healthcheck
-  interval: 3s
+  interval: 5s
   timeout: 2s
   retries: 10
 

diff --git a/docker-compose/microservices-mode/traces/README.md b/docker-compose/microservices-mode/traces/README.md
@@ -14,8 +14,8 @@ flowchart LR
     subgraph Minio
         M{"Object Storage"}
     end
-    subgraph Agent["Grafana Agent"]
-        A("agent")
+    subgraph Agent["Grafana Alloy"]
+        A("alloy")
     end
     subgraph Grafana
         G("grafana")