summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/pkg/web/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/go/collectors/go.d.plugin/pkg/web/doc.go')
-rw-r--r--src/go/collectors/go.d.plugin/pkg/web/doc.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/pkg/web/doc.go b/src/go/collectors/go.d.plugin/pkg/web/doc.go
new file mode 100644
index 000000000..4c6d31461
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/pkg/web/doc.go
@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+/*
+Package web contains HTTP request and client configurations.
+HTTP structure embeds both of them, and it's the only structure that intended to be used as part of a module's configuration.
+Every module that uses HTTP requests to collect metrics should use it.
+It allows to have same set of user configurable options across all modules.
+*/
+package web