diff --git a/docs/guides/metrics-and-limits/_category_.json b/docs/guides/metrics-and-limits/_category_.json new file mode 100644 index 00000000..f46ea994 --- /dev/null +++ b/docs/guides/metrics-and-limits/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Metrics and Limits", + "position": 40, + "link": { + "type": "generated-index" + } +} diff --git a/docs/guides/metrics-and-limits/configuring-metrics.md b/docs/guides/metrics-and-limits/configuring-metrics.md new file mode 100644 index 00000000..cc25e3f0 --- /dev/null +++ b/docs/guides/metrics-and-limits/configuring-metrics.md @@ -0,0 +1,11 @@ +# Configuring Metrics + +A fully configured, production-scale `zrok` service instance looks like this: + +![zrok Metrics Architecture](images/metrics-architecture.png) + +`zrok` metrics builds on top of the `fabric.usage` event type from OpenZiti. The OpenZiti controller has a number of way to emit events. The `zrok` controller has several ways to consume `fabric.usage` events. Smaller installations could be configured in these ways: + +![zrok simplified metrics architecture](images/metrics-architecture-simple.png) + +Environments that horizontally scale the `zrok` control plane with multiple controllers should use an AMQP-based queue to "fan out" the metrics workload across the entire control plane. Simpler installations that use a single `zrok` controller can collect `fabric.usage` events from the OpenZiti controller by "tailing" the events log file, or collecting them from the OpenZiti controller's websocket implementation. \ No newline at end of file diff --git a/docs/guides/metrics-and-limits/images/metrics-architecture-simple.drawio b/docs/guides/metrics-and-limits/images/metrics-architecture-simple.drawio new file mode 100644 index 00000000..2661aed5 --- /dev/null +++ b/docs/guides/metrics-and-limits/images/metrics-architecture-simple.drawio @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/guides/metrics-and-limits/images/metrics-architecture-simple.png b/docs/guides/metrics-and-limits/images/metrics-architecture-simple.png new file mode 100644 index 00000000..ca9fdf41 Binary files /dev/null and b/docs/guides/metrics-and-limits/images/metrics-architecture-simple.png differ diff --git a/docs/guides/metrics-and-limits/images/metrics-architecture.drawio b/docs/guides/metrics-and-limits/images/metrics-architecture.drawio new file mode 100644 index 00000000..13a39db8 --- /dev/null +++ b/docs/guides/metrics-and-limits/images/metrics-architecture.drawio @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/guides/metrics-and-limits/images/metrics-architecture.png b/docs/guides/metrics-and-limits/images/metrics-architecture.png new file mode 100644 index 00000000..063c33a7 Binary files /dev/null and b/docs/guides/metrics-and-limits/images/metrics-architecture.png differ