{"id":23773103,"url":"https://github.com/natrontech/openvpn-exporter","last_synced_at":"2025-10-27T10:15:03.314Z","repository":{"id":270124580,"uuid":"909346940","full_name":"natrontech/openvpn-exporter","owner":"natrontech","description":"A prometheus exporter for OpenVPN","archived":false,"fork":false,"pushed_at":"2025-01-21T16:17:09.000Z","size":73,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-21T17:26:25.811Z","etag":null,"topics":["golang","openvpn","prometheus-exporter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/natrontech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY-INSIGHTS.yml","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-28T12:35:27.000Z","updated_at":"2025-01-21T16:17:11.000Z","dependencies_parsed_at":"2025-01-21T17:23:23.649Z","dependency_job_id":"dd8c674e-9eae-42d5-9a14-004c21e818e4","html_url":"https://github.com/natrontech/openvpn-exporter","commit_stats":null,"previous_names":["natrontech/openvpn-exporter"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natrontech%2Fopenvpn-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natrontech%2Fopenvpn-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natrontech%2Fopenvpn-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natrontech%2Fopenvpn-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/natrontech","download_url":"https://codeload.github.com/natrontech/openvpn-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239960130,"owners_count":19725245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","openvpn","prometheus-exporter"],"created_at":"2025-01-01T05:34:26.628Z","updated_at":"2025-10-27T10:14:58.266Z","avatar_url":"https://github.com/natrontech.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenVPN Exporter\n\n[![license](https://img.shields.io/github/license/natrontech/openvpn-exporter)](https://github.com/natrontech/openvpn-exporter/blob/main/LICENSE)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/natrontech/openvpn-exporter/badge)](https://securityscorecards.dev/viewer/?uri=github.com/natrontech/openvpn-exporter)\n[![release](https://img.shields.io/github/v/release/natrontech/openvpn-exporter)](https://github.com/natrontech/openvpn-exporter/releases)\n[![go-version](https://img.shields.io/github/go-mod/go-version/natrontech/openvpn-exporter)](https://github.com/natrontech/openvpn-exporter/blob/main/go.mod)\n[![Go Report Card](https://goreportcard.com/badge/github.com/natrontech/openvpn-exporter)](https://goreportcard.com/report/github.com/natrontech/openvpn-exporter)\n[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)\n\n---\n\nExport [OpenVPN Community](https://openvpn.net/community-downloads/) statistics to [Prometheus](https://prometheus.io/).\n\nMetrics are retrieved using the OpenVPN Status file.\n\n## Credits\n\nThis project is based on the [OpenVPN Exporter](https://github.com/kumina/openvpn_exporter) by [Kumina](https://www.kumina.nl/).\n\n## Exported Metrics\n\n| Metric                                           | Meaning                                                                | Labels                                                                                        |\n| ------------------------------------------------ | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |\n| openvpn_up                                       | Whether scraping OpenVPN's metrics was successful.                     | `status_path`                                                                                 |\n| openvpn_status_update_time_seconds               | UNIX timestamp at which the OpenVPN statistics were updated.           | `status_path`                                                                                 |\n| openvpn_server_connected_clients                 | Number Of Connected Clients                                            | `status_path`                                                                                 |\n| openvpn_server_client_received_bytes_total       | Amount of data received over a connection on the VPN server, in bytes. | `status_path`, `common_name`, `connection_time` `real_address`, `virtual_address`, `username` |\n| openvpn_server_client_sent_bytes_total           | Amount of data sent over a connection on the VPN server, in bytes.     | `status_path`, `common_name`, `connection_time` `real_address`, `virtual_address`, `username` |\n| openvpn_server_route_last_reference_time_seconds | Time at which a route was last referenced, in seconds.                 | `status_path`, `common_name`, `real_address` `virtual_address`                                |\n| openvpn_client_tun_tap_read_bytes_total          | Total amount of TUN/TAP traffic read, in bytes.                        | `status_path`                                                                                 |\n| openvpn_client_tun_tap_write_bytes_total         | Total amount of TUN/TAP traffic written, in bytes.                     | `status_path`                                                                                 |\n| openvpn_client_tcp_udp_read_bytes_total          | Total amount of TCP/UDP traffic read, in bytes.                        | `status_path`                                                                                 |\n| openvpn_client_tcp_udp_write_bytes_total         | Total amount of TCP/UDP traffic written, in bytes.                     | `status_path`                                                                                 |\n| openvpn_client_auth_read_bytes_total             | Total amount of authentication traffic read, in bytes.                 | `status_path`                                                                                 |\n| openvpn_client_pre_compress_bytes_total          | Total amount of data before compression, in bytes.                     | `status_path`                                                                                 |\n| openvpn_client_post_compress_bytes_total         | Total amount of data after compression, in bytes.                      | `status_path`                                                                                 |\n| openvpn_client_pre_decompress_bytes_total        | Total amount of data before decompression, in bytes.                   | `status_path`                                                                                 |\n| openvpn_client_post_decompress_bytes_total       | Total amount of data after decompression, in bytes.                    | `status_path`                                                                                 |\n\n## Flags / Environment Variables\n\n```bash\n$ ./openvpn-exporter -help\n```\n\nYou can use the following flags to configure the exporter. All flags can also be set using environment variables. Environment variables take precedence over flags.\n\n| Flag                         | Environment Variable         | Description                                                                                     | Default                       |\n| ---------------------------- | ---------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------- |\n| `openvpn.loglevel`           | `OPENVPN_LOGLEVEL`           | Log level (debug, info)                                                                         | `info`                        |\n| `openvpn.status-files`       | `OPENVPN_STATUS_FILES`       | Path to OpenVPN status file. Can be a comma separated list                                      | `/var/log/openvpn-status.log` |\n| `openvpn.metrics-path`       | `OPENVPN_METRICS_PATH`       | Path under which to expose metrics                                                              | `/metrics`                    |\n| `openvpn.listen-address`     | `OPENVPN_LISTEN_ADDRESS`     | Address to listen on for web interface and telemetry                                            | `:9176`                       |\n| `openvpn.ignore-individuals` | `OPENVPN_IGNORE_INDIVIDUALS` | Don't export following labels: `connection_time`, `real_address`, `virtual_address`, `username` | `false`                       |\n\n## Release\n\nEach release of the application includes Go-binary archives, checksums file, SBOMs and container images. \n\nThe release workflow creates provenance for its builds using the [SLSA standard](https://slsa.dev), which conforms to the [Level 3 specification](https://slsa.dev/spec/v1.0/levels#build-l3). Each artifact can be verified using the `slsa-verifier` or `cosign` tool (see [Release verification](SECURITY.md#release-verification)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatrontech%2Fopenvpn-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatrontech%2Fopenvpn-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatrontech%2Fopenvpn-exporter/lists"}