aboutsummaryrefslogtreecommitdiff
path: root/middleware.md
diff options
context:
space:
mode:
Diffstat (limited to 'middleware.md')
-rw-r--r--middleware.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/middleware.md b/middleware.md
index cef243198..acd69f497 100644
--- a/middleware.md
+++ b/middleware.md
@@ -33,7 +33,12 @@ something has been written to the client (by the middleware).
TODO(miek): text here on how to hook up middleware.
-# Documentation
+## Metrics
+
+When exporting metrics the *Namespace* should be `middleware.Namespace` (="coredns"), and the
+*Subsystem* should be the name of the middleware.
+
+## Documentation
Each middleware should have a README.md explaining what the middleware does and how it is
configured. The file should have the following layout:
@@ -44,7 +49,7 @@ configured. The file should have the following layout:
More sections are of course possible.
-## Style
+### Style
We use the Unix manual page style: