Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giantswarm/net-exporter
A Prometheus exporter for exposing network information in Kubernetes clusters
https://github.com/giantswarm/net-exporter
core-component kubernetes prometheus prometheus-exporter
Last synced: 4 months ago
JSON representation
A Prometheus exporter for exposing network information in Kubernetes clusters
- Host: GitHub
- URL: https://github.com/giantswarm/net-exporter
- Owner: giantswarm
- License: apache-2.0
- Created: 2018-07-18T11:37:17.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T08:41:48.000Z (4 months ago)
- Last Synced: 2024-10-25T05:23:06.201Z (4 months ago)
- Topics: core-component, kubernetes, prometheus, prometheus-exporter
- Language: Go
- Homepage: https://giantswarm.io
- Size: 12.8 MB
- Stars: 42
- Watchers: 15
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://dl.circleci.com/status-badge/redirect/gh/giantswarm/net-exporter/tree/main)
[](https://goreportcard.com/report/github.com/giantswarm/net-exporter)
# net-exporter
net-exporter is a Prometheus exporter for exposing network information in Kubernetes clusters.
It is packaged as a Helm chart.
net-exporter runs as a Kubernetes Daemonset. This is to allow for intra-pod network calls,
to determine network latency.
## How to build
Build it using the standard `go build` command.
```bash
go build github.com/giantswarm/net-exporter
```
## Deployment
* Managed by [app-operator].
* Production releases are stored in the [default-catalog].
* WIP releases are stored in the [default-test-catalog].
## Installing the Chart
To install the chart locally:
```bash
$ git clone https://github.com/giantswarm/net-exporter.git
$ cd net-exporter
$ helm install helm/net-exporter
```
Provide a custom `values.yaml`:
```bash
$ helm install net-exporter -f values.yaml
```
## Changes to Charts
At the current stage under [helm](./helm), there are two charts. The [net-exporter](./helm/net-exporter) is pushed to the App Catalog. The [net-exporter-chart](./helm/net-exporter-chart) is pushed to the Quay `appr` repo.
It is **important** that they are kept in sync.
We have this differentiation in place because in our Control Planes, we don't use the app-operator to deploy.
## Release Process
Currently only members of the Giant Swarm organization can create releases for this project.
For up to date steps, please refer to internal docs here: https://intranet.giantswarm.io/docs/dev-and-releng/how-to-release-a-project/
## Collectors
All Collectors are enabled by default.
Name | Description
-----|-------------
dns | Exposes DNS latency statistics. Performs host lookups, exposing the time taken per host.
network | Exposes network latency statistics. Performs dials to the other net-exporter Pods, exposing the time taken per host.
## Metrics
Name | Description
-----|------------
`dns_latency_seconds_bucket` | A Prometheus Histogram of DNS resolution latency. See also `dns_latency_seconds_count` and `dns_latency_seconds_sum`.
`dns_resolve_error_total` | The total number of errors encountered resolving DNS.
`dns_error_total` | The total number of internal errors encountered testing DNS resolution.
`network_latency_seconds_bucket` | A Prometheus Histogram of network latency. See also `network_latency_seconds_count` and `network_latency_seconds_sum`.
`network_dial_error_total` | The total number of errors encountered dialing other hosts.
`network_error_total` | The total number of internal errors encountered testing network latency.
For example (some labels ommited for clarity):
```
dns_latency_seconds_bucket{instance="192.168.120.239:8000", host="kubernetes.default.svc.cluster.local", le="0.008"} | 7
```
Here, we expose the latency for the specific instance to resolve the dns host.
```
network_latency_seconds_bucket{instance="192.168.120.239:8000", host="192.168.120.239:8000", le="0.004"} | 28
```
Here, we expose the latency for the specific instance to resolve another instance (specifically, the net-exporter pod, labeled as host).
## Contact
- Mailing list: [giantswarm](https://groups.google.com/forum/!forum/giantswarm)
- IRC: #[giantswarm](irc://irc.freenode.org:6667/#giantswarm) on freenode.org
- Bugs: [issues](https://github.com/giantswarm/net-exporter/issues)
## Contributing & Reporting Bugs
See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches, the
contribution workflow as well as reporting bugs.
## License
net-exporter is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for
details.