Merge pull request #117 from STCLab-Inc/107-create-a-variety-of-metri…

…c-usage-examples

feat: Create a variety of metric usage examples

.gitignore

@@ -38,6 +38,8 @@ core/wave-cli/vector*
 # core/wave-metrics
 core/wave-metrics/telegraf*
 core/wave-metrics/vector*
+telegraf*/
+vector*/
 
 # VSCode
 .vscode/

.moon/tasks/rust.yml

@@ -1,5 +1,8 @@
 tasks:
-  clean:
+  clean-cargo:
+    command: "cargo clean"
+    platform: "system"
+  clean-db:
     command: "find . -type f -name 'wave.db' -exec rm {} + > /dev/null"
     platform: "system"
     inputs:
@@ -19,7 +22,7 @@ tasks:
   test:
     deps:
       - "lint"
-      - "clean"
+      - "clean-db"
   run:
     deps:
       - "test"

CONTRIBUTING.md

@@ -19,7 +19,25 @@
   $ moon sync hooks
   ```
 
-
+## Development
+
+### When you work on core/wave-autoscale
+```bash
+# Run
+moon run controller:[test|run]
+
+# If you need a situation that metrics are sent to the database and your plan responses to the metrics
+# Edit core/wave-autoscale/tests/simulation.rs for your situation
+moon run controller:test-simulation
+```
+
+### When you work on core/wave-metrics
+- Telegraf Tips
+  ```toml
+  # Print metrics to stdout
+  [[outputs.file]]
+  files = ["stdout"]
+  ```
 ## Coding Rules
 
 ### Rust

core/wave-autoscale/moon.yml

@@ -41,25 +41,7 @@ tasks:
       - "@globs(tests)"
     env:
       RUST_LOG: wave_autoscale=debug
-  # Run
-  run-help:
-    command: "cargo watch -c -x 'run -- --help'"
-    deps:
-      - "lint"
-    inputs:
-      - "@globs(sources)"
-    env:
-      RUST_LOG: debug
-  run-autoscaling-history-retention:
-    # command: "cargo watch -c -x 'run -- --autoscaling-history-retention=1d'"
-    command: "cargo run -- --autoscaling-history-retention=1d"
-    deps:
-      - "lint"
-    inputs:
-      - "@globs(sources)"
-    env:
-      RUST_LOG: wave_controller=debug
-  test-metrics-simulation:
+  test-simulation:
     command: "cargo nextest run -p wave-autoscale test_simulation --no-capture"
     deps:
       - "data-layer:lint"

core/wave-autoscale/tests/metrics_test.rs → core/wave-autoscale/tests/simulation.rs

@@ -1,4 +1,4 @@
-mod metrics_test {
+mod simulation_test {
     use data_layer::data_layer::DataLayer;
     use log::debug;
     use serde_json::json;

core/wave-cli/moon.yml

@@ -41,9 +41,9 @@ tasks:
       - "--config"
       - "../../tests/config/wave-config.yaml"
       - "--definition"
-      - "../wave-metrics/tests/yaml/cloudwatch-definition.yaml"
+      - "../wave-metrics/tests/metrics-examples/vector-host-metrics.yaml"
       - "--collectors-info"
-      - "../wave-metrics/tests/yaml/collectors.yaml"
+      - "../wave-metrics/tests/collectors/collectors.yaml"
     deps:
       # TODO: Build web-app
       - "copy-wave-controller"
@@ -54,6 +54,7 @@ tasks:
       - "wave-api-server"
       - "wave-metrics"
       - "wave-web-app/**/*"
+      - "tests/db/wave.db"
     env:
       RUST_LOG: wave_cli=debug
     options:

core/wave-metrics/moon.yml

@@ -30,11 +30,13 @@ tasks:
       - "--config"
       - "./tests/config/wave-config.yaml"
       - "--definition"
-      - "./core/wave-metrics/tests/yaml/cloudwatch-definition.yaml"
+      - "./core/wave-metrics/tests/metrics-examples/vector-host-metrics.yaml"
       - "--collectors-info"
-      - "./core/wave-metrics/tests/yaml/collectors.yaml"
+      - "./core/wave-metrics/tests/collectors/collectors.yaml"
     env:
       RUST_LOG: wave_metrics=debug
+    inputs:
+      - "@globs(tests)"
   # Build for Production
   # Linux
   build-aarch64-unknown-linux-gnu:

core/wave-metrics/src/metric_collector_manager/mod.rs

@@ -542,8 +542,8 @@ mod tests {
         let _ = std::fs::remove_file("./wave.db");
 
         MetricCollectorManager::new(
-            "./tests/yaml/collectors.yaml",
-            "http://localhost:8081/api/metrics-receiver",
+            "./tests/collectors/collectors.yaml",
+            "http://localhost:3024/api/metrics-receiver",
         )
     }
 

core/wave-metrics/tests/yaml/cloudwatch-definition.yaml → core/wave-metrics/tests/metrics-examples/telegraf-cloudwatch-metrics.yaml

@@ -2,7 +2,7 @@
 # https://github.com/influxdata/telegraf/blob/master/plugins/inputs/cloudwatch/README.md
 ---
 kind: Metric
-id: cloudwatch_dynamodb_metric
+id: cloudwatch_dynamodb_metrics
 collector: telegraf
 metric_kind: cloudwatch
 metadata:
@@ -28,7 +28,7 @@ metadata:
 # Output in the database will be like this:
 # [
 #   {
-#     "name": "cloudwatch_dynamodb_metric_consumed_write_capacity_units_sample_count",
+#     "name": "cloudwatch_dynamodb_metrics_consumed_write_capacity_units_sample_count",
 #     "tags": {
 #       "host": "Hwansoos-Laptop.local",
 #       "region": "ap-northeast-3",
@@ -48,7 +48,7 @@ metadata:
 #     # JavaScript expression that returns a boolean value.
 #     expression: >
 #       get({
-#         name: 'cloudwatch_dynamodb_metric_consumed_write_capacity_units_sample_count'
+#         name: 'cloudwatch_dynamodb_metrics_consumed_write_capacity_units_sample_count'
 #       }) > 30
 #     # Higher priority values will be checked first.
 #     priority: 1

core/wave-metrics/tests/metrics-examples/telegraf-google-cloud-monitoring-metrics.yaml

@@ -0,0 +1,70 @@
+# References - Telegraf Stackdriver Google Cloud Monitoring Input Plugin
+# https://github.com/influxdata/telegraf/blob/release-1.27/plugins/inputs/stackdriver/README.md
+---
+kind: Metric
+id: google_cloud_monitoring_mig_metrics
+collector: telegraf
+metric_kind: stackdriver
+metadata:
+  project: wave-autoscale-test
+  ## Include timeseries that start with the given metric type.
+  metric_type_prefix_include: ["compute.googleapis.com/instance/cpu/utilization"]
+  interval: "1m"
+
+# Output in the database will be like this:
+# [
+#   {
+#     "name": "google_cloud_monitoring_mig_metrics_utilization",
+#     "tags": {
+#       "host": "local",
+#       "instance_id": "3137596874116707338",
+#       "instance_name": "test-instance-group-1-lp73",
+#       "project_id": "wave-autoscale-test",
+#       "resource_type": "gce_instance",
+#       "zone": "asia-northeast2-a"
+#     },
+#     "value": 0.009973257744559306
+#   },
+#   {
+#     "name": "google_cloud_monitoring_mig_metrics_utilization",
+#     "tags": {
+#       "host": "local",
+#       "instance_id": "8022840066979737199",
+#       "instance_name": "instance-group-2-r32v",
+#       "project_id": "wave-autoscale-test",
+#       "resource_type": "gce_instance",
+#       "zone": "asia-northeast2-a"
+#     },
+#     "value": 0.04300702278317961
+#   },
+#   {
+#     "name": "google_cloud_monitoring_mig_metrics_utilization",
+#     "tags": {
+#       "host": "local",
+#       "instance_id": "851205196260609218",
+#       "instance_name": "instance-group-2-wpng",
+#       "project_id": "wave-autoscale-test",
+#       "resource_type": "gce_instance",
+#       "zone": "asia-northeast2-a"
+#     },
+#     "value": 0.0171343613359871
+#   }
+# ]
+
+
+# ---
+# kind: ScalingPlan
+# id: google_scaling_plan
+# title: "Scaling Plan for Google VM Instance"
+# plans:
+#   - id: scale-up-plan-1
+#     description: "Scale up"
+#     # JavaScript expression that returns a boolean value.
+#     expression: >
+#       get({
+#         name: 'google_cloud_monitoring_mig_metrics_utilization'
+#       }) > 0.04
+#     # Higher priority values will be checked first.
+#     priority: 1
+#     scaling_components:
+#      ...

core/wave-metrics/tests/metrics-examples/telegraf-mem-metrics.yaml

@@ -0,0 +1,7 @@
+# https://github.com/influxdata/telegraf/blob/master/plugins/inputs/mem/README.md
+---
+kind: Metric
+id: telegraf_mem_metrics
+collector: telegraf
+metric_kind: mem
+metadata:

core/wave-metrics/tests/metrics-examples/vector-host-metrics.yaml

@@ -0,0 +1,9 @@
+# https://vector.dev/docs/reference/configuration/sources/host_metrics/
+---
+kind: Metric
+id: vector_host_metrics
+collector: vector
+metric_kind: host_metrics
+metadata:
+  namespace: host
+  scrape_interval_secs: 5

core/wave-metrics/tests/metrics-examples/vector-prometheus-metrics.yaml

@@ -0,0 +1,14 @@
+# https://vector.dev/docs/reference/configuration/sources/prometheus_scrape/#query
+---
+kind: Metric
+id: vector_host_metrics
+collector: vector
+metric_kind: prometheus_scrape
+metadata:
+  endpoints:
+    - http://localhost:9090/metrics
+  query:
+      "match[]":
+        - '{job="somejob"}'
+        - '{__name__=~"job:.*"}'
+  scrape_interval_secs: 15