Browse Source

doc: convert etcd to lower-case everywhere

Dmitry Verkhoturov 7 years ago
parent
commit
830d064903
2 changed files with 49 additions and 48 deletions
  1. 24 24
      Documentation/etcd-mixin/mixin.libsonnet
  2. 25 24
      Documentation/op-guide/etcd3_alert.rules.yml

+ 24 - 24
Documentation/etcd-mixin/mixin.libsonnet

@@ -9,7 +9,7 @@
         name: 'etcd',
         rules: [
           {
-            alert: 'EtcdInsufficientMembers',
+            alert: 'etcdInsufficientMembers',
             expr: |||
               sum(up{%(etcd_selector)s} == bool 1) by (job) < ((count(up{%(etcd_selector)s}) by (job) + 1) / 2)
             ||| % $._config,
@@ -18,11 +18,11 @@
               severity: 'critical',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": insufficient members ({{ $value }}).',
+              message: 'etcd cluster "{{ $labels.job }}": insufficient members ({{ $value }}).',
             },
           },
           {
-            alert: 'EtcdNoLeader',
+            alert: 'etcdNoLeader',
             expr: |||
               etcd_server_has_leader{%(etcd_selector)s} == 0
             ||| % $._config,
@@ -31,11 +31,11 @@
               severity: 'critical',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": member {{ $labels.instance }} has no leader.',
+              message: 'etcd cluster "{{ $labels.job }}": member {{ $labels.instance }} has no leader.',
             },
           },
           {
-            alert: 'EtcdHighNumberOfLeaderChanges',
+            alert: 'etcdHighNumberOfLeaderChanges',
             expr: |||
               rate(etcd_server_leader_changes_seen_total{%(etcd_selector)s}[15m]) > 3
             ||| % $._config,
@@ -44,11 +44,11 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": instance {{ $labels.instance }} has seen {{ $value }} leader changes within the last hour.',
+              message: 'etcd cluster "{{ $labels.job }}": instance {{ $labels.instance }} has seen {{ $value }} leader changes within the last hour.',
             },
           },
           {
-            alert: 'EtcdHighNumberOfFailedGRPCRequests',
+            alert: 'etcdHighNumberOfFailedGRPCRequests',
             expr: |||
               100 * sum(rate(grpc_server_handled_total{%(etcd_selector)s, grpc_code!="OK"}[5m])) BY (job, instance, grpc_service, grpc_method)
                 /
@@ -60,11 +60,11 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{ $labels.grpc_method }} failed on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{ $labels.grpc_method }} failed on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdHighNumberOfFailedGRPCRequests',
+            alert: 'etcdHighNumberOfFailedGRPCRequests',
             expr: |||
               100 * sum(rate(grpc_server_handled_total{%(etcd_selector)s, grpc_code!="OK"}[5m])) BY (job, instance, grpc_service, grpc_method)
                 /
@@ -76,11 +76,11 @@
               severity: 'critical',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{ $labels.grpc_method }} failed on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{ $labels.grpc_method }} failed on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdGRPCRequestsSlow',
+            alert: 'etcdGRPCRequestsSlow',
             expr: |||
               histogram_quantile(0.99, sum(rate(grpc_server_handling_seconds_bucket{%(etcd_selector)s, grpc_type="unary"}[5m])) by (job, instance, grpc_service, grpc_method, le))
               > 0.15
@@ -90,11 +90,11 @@
               severity: 'critical',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": gRPC requests to {{ $labels.grpc_method }} are taking {{ $value }}s on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": gRPC requests to {{ $labels.grpc_method }} are taking {{ $value }}s on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdMemberCommunicationSlow',
+            alert: 'etcdMemberCommunicationSlow',
             expr: |||
               histogram_quantile(0.99, rate(etcd_network_peer_round_trip_time_seconds_bucket{%(etcd_selector)s}[5m]))
               > 0.15
@@ -104,11 +104,11 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": member communication with {{ $labels.To }} is taking {{ $value }}s on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": member communication with {{ $labels.To }} is taking {{ $value }}s on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdHighNumberOfFailedProposals',
+            alert: 'etcdHighNumberOfFailedProposals',
             expr: |||
               rate(etcd_server_proposals_failed_total{%(etcd_selector)s}[15m]) > 5
             ||| % $._config,
@@ -117,11 +117,11 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": {{ $value }} proposal failures within the last hour on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": {{ $value }} proposal failures within the last hour on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdHighFsyncDurations',
+            alert: 'etcdHighFsyncDurations',
             expr: |||
               histogram_quantile(0.99, rate(etcd_disk_wal_fsync_duration_seconds_bucket{%(etcd_selector)s}[5m]))
               > 0.5
@@ -131,11 +131,11 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": 99th percentile fync durations are {{ $value }}s on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": 99th percentile fync durations are {{ $value }}s on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdHighCommitDurations',
+            alert: 'etcdHighCommitDurations',
             expr: |||
               histogram_quantile(0.99, rate(etcd_disk_backend_commit_duration_seconds_bucket{%(etcd_selector)s}[5m]))
               > 0.25
@@ -145,11 +145,11 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd cluster "{{ $labels.job }}": 99th percentile commit durations {{ $value }}s on etcd instance {{ $labels.instance }}.',
+              message: 'etcd cluster "{{ $labels.job }}": 99th percentile commit durations {{ $value }}s on etcd instance {{ $labels.instance }}.',
             },
           },
           {
-            alert: 'EtcdHighNumberOfFailedHTTPRequests',
+            alert: 'etcdHighNumberOfFailedHTTPRequests',
             expr: |||
               sum(rate(etcd_http_failed_total{%(etcd_selector)s}[5m])) BY (method) / sum(rate(etcd_http_received_total{%(etcd_selector)s}[5m]))
               BY (method) > 0.01
@@ -163,7 +163,7 @@
             },
           },
           {
-            alert: 'EtcdHighNumberOfFailedHTTPRequests',
+            alert: 'etcdHighNumberOfFailedHTTPRequests',
             expr: |||
               sum(rate(etcd_http_failed_total{%(etcd_selector)s}[5m])) BY (method) / sum(rate(etcd_http_received_total{%(etcd_selector)s}[5m]))
               BY (method) > 0.05
@@ -177,7 +177,7 @@
             },
           },
           {
-            alert: 'EtcdHTTPRequestsSlow',
+            alert: 'etcdHTTPRequestsSlow',
             expr: |||
               histogram_quantile(0.99, rate(etcd_http_successful_duration_seconds_bucket[5m]))
               > 0.15
@@ -187,7 +187,7 @@
               severity: 'warning',
             },
             annotations: {
-              message: 'Etcd instance {{ $labels.instance }} HTTP requests to {{ $labels.method }} are slow.',
+              message: 'etcd instance {{ $labels.instance }} HTTP requests to {{ $labels.method }} are slow.',
             },
           },
         ],

+ 25 - 24
Documentation/op-guide/etcd3_alert.rules.yml

@@ -1,36 +1,37 @@
+# these rules synced manually from https://github.com/etcd-io/etcd/blob/master/Documentation/etcd-mixin/mixin.libsonnet
 groups:
 - name: etcd
   rules:
-  - alert: EtcdInsufficientMembers
+  - alert: etcdInsufficientMembers
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": insufficient members ({{ $value
+      message: 'etcd cluster "{{ $labels.job }}": insufficient members ({{ $value
         }}).'
     expr: |
       sum(up{job=~".*etcd.*"} == bool 1) by (job) < ((count(up{job=~".*etcd.*"}) by (job) + 1) / 2)
     for: 3m
     labels:
       severity: critical
-  - alert: EtcdNoLeader
+  - alert: etcdNoLeader
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": member {{ $labels.instance }} has
+      message: 'etcd cluster "{{ $labels.job }}": member {{ $labels.instance }} has
         no leader.'
     expr: |
       etcd_server_has_leader{job=~".*etcd.*"} == 0
     for: 1m
     labels:
       severity: critical
-  - alert: EtcdHighNumberOfLeaderChanges
+  - alert: etcdHighNumberOfLeaderChanges
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": instance {{ $labels.instance }}
+      message: 'etcd cluster "{{ $labels.job }}": instance {{ $labels.instance }}
         has seen {{ $value }} leader changes within the last hour.'
     expr: |
       rate(etcd_server_leader_changes_seen_total{job=~".*etcd.*"}[15m]) > 3
     for: 15m
     labels:
       severity: warning
-  - alert: EtcdHighNumberOfFailedGRPCRequests
+  - alert: etcdHighNumberOfFailedGRPCRequests
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{
+      message: 'etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{
         $labels.grpc_method }} failed on etcd instance {{ $labels.instance }}.'
     expr: |
       100 * sum(rate(grpc_server_handled_total{job=~".*etcd.*", grpc_code!="OK"}[5m])) BY (job, instance, grpc_service, grpc_method)
@@ -40,9 +41,9 @@ groups:
     for: 10m
     labels:
       severity: warning
-  - alert: EtcdHighNumberOfFailedGRPCRequests
+  - alert: etcdHighNumberOfFailedGRPCRequests
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{
+      message: 'etcd cluster "{{ $labels.job }}": {{ $value }}% of requests for {{
         $labels.grpc_method }} failed on etcd instance {{ $labels.instance }}.'
     expr: |
       100 * sum(rate(grpc_server_handled_total{job=~".*etcd.*", grpc_code!="OK"}[5m])) BY (job, instance, grpc_service, grpc_method)
@@ -52,9 +53,9 @@ groups:
     for: 5m
     labels:
       severity: critical
-  - alert: EtcdGRPCRequestsSlow
+  - alert: etcdGRPCRequestsSlow
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": gRPC requests to {{ $labels.grpc_method
+      message: 'etcd cluster "{{ $labels.job }}": gRPC requests to {{ $labels.grpc_method
         }} are taking {{ $value }}s on etcd instance {{ $labels.instance }}.'
     expr: |
       histogram_quantile(0.99, sum(rate(grpc_server_handling_seconds_bucket{job=~".*etcd.*", grpc_type="unary"}[5m])) by (job, instance, grpc_service, grpc_method, le))
@@ -62,9 +63,9 @@ groups:
     for: 10m
     labels:
       severity: critical
-  - alert: EtcdMemberCommunicationSlow
+  - alert: etcdMemberCommunicationSlow
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": member communication with {{ $labels.To
+      message: 'etcd cluster "{{ $labels.job }}": member communication with {{ $labels.To
         }} is taking {{ $value }}s on etcd instance {{ $labels.instance }}.'
     expr: |
       histogram_quantile(0.99, rate(etcd_network_peer_round_trip_time_seconds_bucket{job=~".*etcd.*"}[5m]))
@@ -72,18 +73,18 @@ groups:
     for: 10m
     labels:
       severity: warning
-  - alert: EtcdHighNumberOfFailedProposals
+  - alert: etcdHighNumberOfFailedProposals
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": {{ $value }} proposal failures within
+      message: 'etcd cluster "{{ $labels.job }}": {{ $value }} proposal failures within
         the last hour on etcd instance {{ $labels.instance }}.'
     expr: |
       rate(etcd_server_proposals_failed_total{job=~".*etcd.*"}[15m]) > 5
     for: 15m
     labels:
       severity: warning
-  - alert: EtcdHighFsyncDurations
+  - alert: etcdHighFsyncDurations
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": 99th percentile fync durations are
+      message: 'etcd cluster "{{ $labels.job }}": 99th percentile fync durations are
         {{ $value }}s on etcd instance {{ $labels.instance }}.'
     expr: |
       histogram_quantile(0.99, rate(etcd_disk_wal_fsync_duration_seconds_bucket{job=~".*etcd.*"}[5m]))
@@ -91,9 +92,9 @@ groups:
     for: 10m
     labels:
       severity: warning
-  - alert: EtcdHighCommitDurations
+  - alert: etcdHighCommitDurations
     annotations:
-      message: 'Etcd cluster "{{ $labels.job }}": 99th percentile commit durations
+      message: 'etcd cluster "{{ $labels.job }}": 99th percentile commit durations
         {{ $value }}s on etcd instance {{ $labels.instance }}.'
     expr: |
       histogram_quantile(0.99, rate(etcd_disk_backend_commit_duration_seconds_bucket{job=~".*etcd.*"}[5m]))
@@ -101,7 +102,7 @@ groups:
     for: 10m
     labels:
       severity: warning
-  - alert: EtcdHighNumberOfFailedHTTPRequests
+  - alert: etcdHighNumberOfFailedHTTPRequests
     annotations:
       message: '{{ $value }}% of requests for {{ $labels.method }} failed on etcd
         instance {{ $labels.instance }}'
@@ -111,7 +112,7 @@ groups:
     for: 10m
     labels:
       severity: warning
-  - alert: EtcdHighNumberOfFailedHTTPRequests
+  - alert: etcdHighNumberOfFailedHTTPRequests
     annotations:
       message: '{{ $value }}% of requests for {{ $labels.method }} failed on etcd
         instance {{ $labels.instance }}.'
@@ -121,9 +122,9 @@ groups:
     for: 10m
     labels:
       severity: critical
-  - alert: EtcdHTTPRequestsSlow
+  - alert: etcdHTTPRequestsSlow
     annotations:
-      message: Etcd instance {{ $labels.instance }} HTTP requests to {{ $labels.method
+      message: etcd instance {{ $labels.instance }} HTTP requests to {{ $labels.method
         }} are slow.
     expr: |
       histogram_quantile(0.99, rate(etcd_http_successful_duration_seconds_bucket[5m]))