mirror of
https://github.com/netdata/netdata.git
synced 2025-04-10 08:07:34 +00:00
update go.d path in docs and ci (#18087)
This commit is contained in:
Ilya Mashchenko
GitHub
parent
e1a1c4ca4f
commit
a8757ff1c5
20 changed files with 61 additions and 67 deletions
.github/workflows
docs/developer-and-contributor-corner
src/go/plugin/go.d
README.md
agent
docs
modules
bind
coredns
example
httpcheck
isc_dhcpd
mongodb
openvpn
openvpn_status_log
ping
prometheus
weblog
pkg
2
.github/workflows/generate-integrations.yml
vendored
2
.github/workflows/generate-integrations.yml
vendored
|
|
@ -7,7 +7,7 @@ on:
|
|||
- master
|
||||
paths: # If any of these files change, we need to regenerate integrations.js.
|
||||
- 'src/collectors/**/metadata.yaml'
|
||||
- 'src/go/collectors/**/metadata.yaml'
|
||||
- 'src/go/plugin/**/metadata.yaml'
|
||||
- 'src/exporting/**/metadata.yaml'
|
||||
- 'src/health/notifications/**/metadata.yaml'
|
||||
- 'integrations/templates/**'
|
||||
|
|
|
|||
|
|
@ -58,9 +58,7 @@ configuring the collector.
|
|||
You may not need to do any more configuration to have Netdata collect your Unbound metrics.
|
||||
|
||||
If you followed the steps above to enable `remote-control` and make your Unbound files readable by Netdata, that should
|
||||
be enough. Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
|
||||
method](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system. You should see Unbound metrics in your Netdata
|
||||
dashboard!
|
||||
be enough. Restart Netdata with `sudo systemctl restart netdata`, or the appropriate method for your system. You should see Unbound metrics in your Netdata dashboard!
|
||||
|
||||
|
||||
|
||||
|
|
@ -93,7 +91,7 @@ jobs:
|
|||
tls_skip_verify: yes
|
||||
tls_cert: /path/to/unbound_control.pem
|
||||
tls_key: /path/to/unbound_control.key
|
||||
|
||||
|
||||
- name: local
|
||||
address: 127.0.0.1:8953
|
||||
cumulative: yes
|
||||
|
|
@ -101,16 +99,15 @@ jobs:
|
|||
```
|
||||
|
||||
Netdata will attempt to read `unbound.conf` to get the appropriate `address`, `cumulative`, `use_tls`, `tls_cert`, and
|
||||
`tls_key` parameters.
|
||||
`tls_key` parameters.
|
||||
|
||||
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
|
||||
method](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system.
|
||||
Restart Netdata with `sudo systemctl restart netdata`, or the appropriate method for your system.
|
||||
|
||||
### Manual setup for a remote Unbound server
|
||||
|
||||
Collecting metrics from remote Unbound servers requires manual configuration. There are too many possibilities to cover
|
||||
all remote connections here, but the [default `unbound.conf`
|
||||
file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/unbound.conf) contains a few useful examples:
|
||||
file](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d/unbound.conf) contains a few useful examples:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
|
|
@ -132,7 +129,7 @@ jobs:
|
|||
```
|
||||
|
||||
To see all the available options, see the default [unbound.conf
|
||||
file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/unbound.conf).
|
||||
file](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d/unbound.conf).
|
||||
|
||||
## What's next?
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<!--
|
||||
title: go.d.plugin
|
||||
description: "go.d.plugin is an external plugin for Netdata, responsible for running individual data collectors written in Go."
|
||||
custom_edit_url: "/src/go/collectors/go.d.plugin/README.md"
|
||||
custom_edit_url: "/src/go/plugin/go.d/README.md"
|
||||
sidebar_label: "go.d.plugin"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
|
|
@ -119,8 +119,8 @@ see the appropriate collector readme.
|
|||
| [redis](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/redis) | Redis |
|
||||
| [rspamd](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/rspamd) | Rspamd |
|
||||
| [scaleio](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/scaleio) | Dell EMC ScaleIO |
|
||||
| [sensors](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/modules) | Hardware Sensors |
|
||||
| [SNMP](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/snmp) | SNMP |
|
||||
| [sensors](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/sensors) | Hardware Sensors |
|
||||
| [SNMP](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/snmp) | SNMP |
|
||||
| [squidlog](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/squidlog) | Squid |
|
||||
| [smartctl](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/smartctl) | S.M.A.R.T Storage Devices |
|
||||
| [storcli](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/storcli) | Broadcom Hardware RAID |
|
||||
|
|
@ -154,8 +154,8 @@ sudo ./edit-config go.d.conf
|
|||
|
||||
Configurations are written in [YAML](http://yaml.org/).
|
||||
|
||||
- [plugin configuration](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d.conf)
|
||||
- [specific module configuration](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/config/go.d)
|
||||
- [plugin configuration](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d.conf)
|
||||
- [specific module configuration](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/config/go.d)
|
||||
|
||||
### Enable a collector
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ You are responsible only for __creating modules__.
|
|||
|
||||
## Custom plugin example
|
||||
|
||||
[Yep! So easy!](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/examples/simple/main.go)
|
||||
[Yep! So easy!](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/examples/simple/main.go)
|
||||
|
||||
## How to write a Module
|
||||
|
||||
|
|
@ -71,7 +71,7 @@ func (b *Base) SetLogger(l *logger.Logger) { b.Logger = l }
|
|||
|
||||
Since plugin is a set of modules all you need is:
|
||||
- write module(s)
|
||||
- add module(s) to the plugins [registry](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/plugin/module/registry.go)
|
||||
- add module(s) to the plugins [registry](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/plugin/module/registry.go)
|
||||
- start the plugin
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<!--
|
||||
title: "How to write a Netdata collector in Go"
|
||||
description: "This guide will walk you through the technical implementation of writing a new Netdata collector in Golang, with tips on interfaces, structure, configuration files, and more."
|
||||
custom_edit_url: "/src/go/collectors/go.d.plugin/docs/how-to-write-a-module.md"
|
||||
custom_edit_url: "/src/go/plugin/go.d/docs/how-to-write-a-module.md"
|
||||
sidebar_label: "How to write a Netdata collector in Go"
|
||||
learn_status: "Published"
|
||||
learn_topic_type: "Tasks"
|
||||
|
|
@ -23,7 +23,7 @@ sidebar_position: 20
|
|||
## Write and test a simple collector
|
||||
|
||||
> :exclamation: You can skip most of these steps if you first experiment directy with the existing
|
||||
> [example module](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/modules/example), which
|
||||
> [example module](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/example), which
|
||||
> will
|
||||
> give you an idea of how things work.
|
||||
|
||||
|
|
@ -32,18 +32,18 @@ Let's assume you want to write a collector named `example2`.
|
|||
The steps are:
|
||||
|
||||
- Add the source code
|
||||
to [`modules/example2/`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/modules).
|
||||
to [`modules/example2/`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules).
|
||||
- [module interface](#module-interface).
|
||||
- [suggested module layout](#module-layout).
|
||||
- [helper packages](#helper-packages).
|
||||
- Add the configuration
|
||||
to [`config/go.d/example2.conf`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/config/go.d).
|
||||
to [`config/go.d/example2.conf`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/config/go.d).
|
||||
- Add the module
|
||||
to [`config/go.d.conf`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d.conf).
|
||||
to [`config/go.d.conf`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d.conf).
|
||||
- Import the module
|
||||
in [`modules/init.go`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/init.go).
|
||||
in [`modules/init.go`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/init.go).
|
||||
- Update
|
||||
the [`available modules list`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin#available-modules).
|
||||
the [`available modules list`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d#available-modules).
|
||||
- To build it, run `make` from the plugin root dir. This will create a new `go.d.plugin` binary that includes your newly
|
||||
developed collector. It will be placed into the `bin` directory (e.g `go.d.plugin/bin`)
|
||||
- Run it in the debug mode `bin/godplugin -d -m <MODULE_NAME>`. This will output the `STDOUT` of the collector, the same
|
||||
|
|
@ -51,10 +51,7 @@ The steps are:
|
|||
our [documentation](/src/collectors/plugins.d/README.md#external-plugins-api).
|
||||
- If you want to test the collector with the actual Netdata Agent, you need to replace the `go.d.plugin` binary that
|
||||
exists in the Netdata Agent installation directory with the one you just compiled. Once
|
||||
you [restart](/packaging/installer/README.md#maintaining-a-netdata-agent-installation)
|
||||
the Netdata Agent, it will detect and run
|
||||
it, creating all the charts. It is advised not to remove the default `go.d.plugin` binary, but simply rename it
|
||||
to `go.d.plugin.old` so that the Agent doesn't run it, but you can easily rename it back once you are done.
|
||||
you restart the Netdata Agent, it will detect and run it, creating all the charts. It is advised not to remove the default `go.d.plugin` binary, but simply rename it to `go.d.plugin.old` so that the Agent doesn't run it, but you can easily rename it back once you are done.
|
||||
- Run `make clean` when you are done with testing.
|
||||
|
||||
## Module Interface
|
||||
|
|
@ -125,7 +122,7 @@ func (e *Example) Check() bool {
|
|||
produces [`charts`](/src/collectors/plugins.d/README.md#chart), not
|
||||
raw metrics.
|
||||
|
||||
Use [`agent/module`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/agent/module/charts.go)
|
||||
Use [`agent/module`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/agent/module/charts.go)
|
||||
package to create them,
|
||||
it contains charts and dimensions structs.
|
||||
|
||||
|
|
@ -205,7 +202,7 @@ Suggested minimal layout:
|
|||
### File `module_name.go`
|
||||
|
||||
> :exclamation: See the
|
||||
> example [`example.go`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/example/example.go).
|
||||
> example [`example.go`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/example/example.go).
|
||||
|
||||
Don't overload this file with the implementation details.
|
||||
|
||||
|
|
@ -218,14 +215,14 @@ Usually it contains only:
|
|||
### File `charts.go`
|
||||
|
||||
> :exclamation: See the
|
||||
> example: [`charts.go`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/example/charts.go).
|
||||
> example: [`charts.go`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/example/charts.go).
|
||||
|
||||
Put charts, charts templates and charts constructor functions in this file.
|
||||
|
||||
### File `init.go`
|
||||
|
||||
> :exclamation: See the
|
||||
> example: [`init.go`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/example/init.go).
|
||||
> example: [`init.go`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/example/init.go).
|
||||
|
||||
All the module initialization details should go in this file.
|
||||
|
||||
|
|
@ -252,7 +249,7 @@ func (e *Example) initSomeValue() error {
|
|||
### File `collect.go`
|
||||
|
||||
> :exclamation: See the
|
||||
> example: [`collect.go`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/example/collect.go).
|
||||
> example: [`collect.go`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/example/collect.go).
|
||||
|
||||
This file is the entry point for the metrics collection.
|
||||
|
||||
|
|
@ -275,7 +272,7 @@ func (e *Example) collect() (map[string]int64, error) {
|
|||
### File `module_name_test.go`
|
||||
|
||||
> :exclamation: See the
|
||||
> example: [`example_test.go`](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/example/example_test.go).
|
||||
> example: [`example_test.go`](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/example/example_test.go).
|
||||
|
||||
> if you have no experience in testing we recommend starting
|
||||
> with [testing package documentation](https://golang.org/pkg/testing/).
|
||||
|
|
@ -300,6 +297,6 @@ be [`testdata`](https://golang.org/cmd/go/#hdr-Package_lists_and_patterns).
|
|||
|
||||
## Helper packages
|
||||
|
||||
There are [some helper packages](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg) for
|
||||
There are [some helper packages](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg) for
|
||||
writing a module.
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ jobs:
|
|||
View filter syntax: [simple patterns](https://docs.netdata.cloud/libnetdata/simple_pattern/).
|
||||
|
||||
For all available options please see
|
||||
module [configuration file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/bind.conf).
|
||||
module [configuration file](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d/bind.conf).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@
|
|||
"properties": {
|
||||
"includes": {
|
||||
"title": "Include",
|
||||
"description": "Include servers whose names match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Include servers whose names match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -53,7 +53,7 @@
|
|||
},
|
||||
"excludes": {
|
||||
"title": "Exclude",
|
||||
"description": "Exclude servers whose names match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Exclude servers whose names match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -76,7 +76,7 @@
|
|||
"properties": {
|
||||
"includes": {
|
||||
"title": "Include",
|
||||
"description": "Include zones whose names match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Include zones whose names match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -89,7 +89,7 @@
|
|||
},
|
||||
"excludes": {
|
||||
"title": "Exclude",
|
||||
"description": "Exclude zones whose names match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Exclude zones whose names match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ sudo ./edit-config go.d/example.conf
|
|||
```
|
||||
|
||||
Disabled by default. Should be explicitly enabled
|
||||
in [go.d.conf](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d.conf).
|
||||
in [go.d.conf](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d.conf).
|
||||
|
||||
```yaml
|
||||
# go.d.conf
|
||||
|
|
@ -53,7 +53,7 @@ jobs:
|
|||
---
|
||||
|
||||
For all available options, see the Example
|
||||
collector's [configuration file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/example.conf).
|
||||
collector's [configuration file](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/config/go.d/example.conf).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@
|
|||
},
|
||||
"value": {
|
||||
"title": "Header value pattern",
|
||||
"description": "Specifies the [matcher pattern](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme) to match against the value of the specified header.",
|
||||
"description": "Specifies the [matcher pattern](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme) to match against the value of the specified header.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@
|
|||
},
|
||||
"networks": {
|
||||
"title": "Networks",
|
||||
"description": "A space-separated list of [IP ranges](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/iprange#supported-formats) for the pool.",
|
||||
"description": "A space-separated list of [IP ranges](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/iprange#supported-formats) for the pool.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@
|
|||
"properties": {
|
||||
"includes": {
|
||||
"title": "Include",
|
||||
"description": "Include databases that match any of the specified include [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Include databases that match any of the specified include [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -47,7 +47,7 @@
|
|||
},
|
||||
"excludes": {
|
||||
"title": "Exclude",
|
||||
"description": "Exclude databases that match any of the specified exclude [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Exclude databases that match any of the specified exclude [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@
|
|||
"properties": {
|
||||
"includes": {
|
||||
"title": "Include",
|
||||
"description": "Include users whose usernames match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Include users whose usernames match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -47,7 +47,7 @@
|
|||
},
|
||||
"excludes": {
|
||||
"title": "Exclude",
|
||||
"description": "Exclude users whose usernames match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Exclude users whose usernames match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
"properties": {
|
||||
"includes": {
|
||||
"title": "Include",
|
||||
"description": "Include users whose usernames match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Include users whose usernames match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -41,7 +41,7 @@
|
|||
},
|
||||
"excludes": {
|
||||
"title": "Exclude",
|
||||
"description": "Exclude users whose usernames match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
|
||||
"description": "Exclude users whose usernames match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
},
|
||||
"privileged": {
|
||||
"title": "Privileged mode",
|
||||
"description": "If unset, sends unprivileged UDP ping packets (require [additional configuration](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/modules/ping#overview)); otherwise, sends raw ICMP ping packets ([not recommended](https://github.com/netdata/netdata/issues/15410)).",
|
||||
"description": "If unset, sends unprivileged UDP ping packets (require [additional configuration](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/ping#overview)); otherwise, sends raw ICMP ping packets ([not recommended](https://github.com/netdata/netdata/issues/15410)).",
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@
|
|||
"properties": {
|
||||
"allow": {
|
||||
"title": "Allow",
|
||||
"description": "Allow time series that match any of the specified [selectors](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/prometheus/selector#readme).",
|
||||
"description": "Allow time series that match any of the specified [selectors](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/prometheus/selector#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
@ -62,7 +62,7 @@
|
|||
},
|
||||
"deny": {
|
||||
"title": "Deny",
|
||||
"description": "Deny time series that match any of the specified [selectors](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/prometheus/selector#readme).",
|
||||
"description": "Deny time series that match any of the specified [selectors](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/prometheus/selector#readme).",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@
|
|||
},
|
||||
"match": {
|
||||
"title": "Pattern",
|
||||
"description": "The [pattern string](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme) used to match against the full original request URI.",
|
||||
"description": "The [pattern string](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme) used to match against the full original request URI.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
|
@ -123,7 +123,7 @@
|
|||
},
|
||||
"match": {
|
||||
"title": "Pattern",
|
||||
"description": "The [pattern string](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme) used to match against the field value.",
|
||||
"description": "The [pattern string](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/matcher#readme) used to match against the field value.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<!--
|
||||
title: "Helper Packages"
|
||||
custom_edit_url: "/src/go/collectors/go.d.plugin/pkg/README.md"
|
||||
custom_edit_url: "/src/go/plugin/go.d/pkg/README.md"
|
||||
sidebar_label: "Helper Packages"
|
||||
learn_status: "Published"
|
||||
learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"
|
||||
|
|
@ -9,14 +9,14 @@ learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"
|
|||
# Helper Packages
|
||||
|
||||
- if you need IP ranges consider to
|
||||
use [`iprange`](/src/go/plugin/pkgmd).
|
||||
- if you parse an application log files, then [`log`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/logs) is
|
||||
use [`iprange`](/src/go/plugin/go.d/pkg/iprange).
|
||||
- if you parse an application log files, then [`log`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/logs) is
|
||||
handy.
|
||||
- if you need filtering
|
||||
check [`matcher`](/src/go/plugin/pkgmd).
|
||||
- if you collect metrics from an HTTP endpoint use [`web`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/web).
|
||||
check [`matcher`](/src/go/plugin/go.d/pkg/matcher).
|
||||
- if you collect metrics from an HTTP endpoint use [`web`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/web).
|
||||
- if you collect metrics from a prometheus endpoint,
|
||||
then [`prometheus`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/prometheus)
|
||||
and [`web`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/web) is what you need.
|
||||
- [`tlscfg`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/tlscfg) provides TLS support.
|
||||
- [`stm`](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/stm) helps you to convert any struct to a `map[string]int64`.
|
||||
then [`prometheus`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/prometheus)
|
||||
and [`web`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/web) is what you need.
|
||||
- [`tlscfg`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/tlscfg) provides TLS support.
|
||||
- [`stm`](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/stm) helps you to convert any struct to a `map[string]int64`.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<!--
|
||||
title: "iprange"
|
||||
custom_edit_url: "/src/go/collectors/go.d.plugin/pkg/iprange/README.md"
|
||||
custom_edit_url: "/src/go/plugin/go.d/pkg/iprange/README.md"
|
||||
sidebar_label: "iprange"
|
||||
learn_status: "Published"
|
||||
learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<!--
|
||||
title: "matcher"
|
||||
custom_edit_url: "/src/go/collectors/go.d.plugin/pkg/matcher/README.md"
|
||||
custom_edit_url: "/src/go/plugin/go.d/pkg/matcher/README.md"
|
||||
sidebar_label: "matcher"
|
||||
learn_status: "Published"
|
||||
learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<!--
|
||||
title: "Time series selector"
|
||||
custom_edit_url: "/src/go/collectors/go.d.plugin/pkg/prometheus/selector/README.md"
|
||||
custom_edit_url: "/src/go/plugin/go.d/pkg/prometheus/selector/README.md"
|
||||
sidebar_label: "Time series selector"
|
||||
learn_status: "Published"
|
||||
learn_rel_path: "Developers/External plugins/go.d.plugin/Helper Packages"
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue