Skip to content

Commit

Permalink
docs: add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rogercoll committed Oct 22, 2022
1 parent 0e506d3 commit 1f5aeff
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Wireguard Stats Receiver

The Wireguard stats recevier queries the stats of the connected
Wireguard peers via generic netlink (Linux).
[wgctrl](https://github.com/WireGuard/wgctrl-go) is used to fetch the
stats and for the objects definition.

This receiver can we integrated with the custom [OpenTelemetry Collector
Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder)
3 changes: 2 additions & 1 deletion config.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ var _ config.Receiver = (*Config)(nil)

type Config struct {
scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
Exclude ExcludeConfig `mapstructure:"exclude"`
// TODO: implement exclude option
Exclude ExcludeConfig `mapstructure:"exclude"`
}

type ExcludeConfig struct {
Expand Down

0 comments on commit 1f5aeff

Please sign in to comment.