Directories
¶
| Path | Synopsis |
|---|---|
|
Package central is the composition root of the central: it reads the configuration, builds every part and serves the three listeners (edge gateway, STUN, API and UI).
|
Package central is the composition root of the central: it reads the configuration, builds every part and serves the three listeners (edge gateway, STUN, API and UI). |
|
alerting
Package alerting turns rules into alerts and alerts into signed webhooks.
|
Package alerting turns rules into alerts and alerts into signed webhooks. |
|
api
Package api implements the API used by the UI: edges, targets, results, traceroutes, data lifecycle, accounts and alerting.
|
Package api implements the API used by the UI: edges, targets, results, traceroutes, data lifecycle, accounts and alerting. |
|
asn
Package asn looks up the autonomous system of an address in a MaxMind DB file (DB-IP ASN Lite or GeoLite2-ASN).
|
Package asn looks up the autonomous system of an address in a MaxMind DB file (DB-IP ASN Lite or GeoLite2-ASN). |
|
audit
Package audit records every change made through the admin API.
|
Package audit records every change made through the admin API. |
|
auth
Package auth handles UI accounts: password login and cookie sessions.
|
Package auth handles UI accounts: password login and cookie sessions. |
|
enroll
Package enroll owns the enrollment token: its format, how it is made and read back, and the command an operator runs on a new edge.
|
Package enroll owns the enrollment token: its format, how it is made and read back, and the command an operator runs on a new edge. |
|
export
Package export writes measurements as CSV, for archives and spreadsheets.
|
Package export writes measurements as CSV, for archives and spreadsheets. |
|
fleet
Package fleet holds the live state of the edges: sessions, assignments and observed addresses.
|
Package fleet holds the live state of the edges: sessions, assignments and observed addresses. |
|
gateway
Package gateway implements the internet facing side of the central: enrollment, certificate renewal, edge sessions, result reports and STUN.
|
Package gateway implements the internet facing side of the central: enrollment, certificate renewal, edge sessions, result reports and STUN. |
|
realip
Package realip recovers the client address behind a reverse proxy.
|
Package realip recovers the client address behind a reverse proxy. |
|
secrets
Package secrets seals values kept in the database, the webhook signing secrets, with a key stored next to the CA: a copy of the database alone is not enough to forge signatures.
|
Package secrets seals values kept in the database, the webhook signing secrets, with a key stored next to the CA: a copy of the database alone is not enough to forge signatures. |
|
store
Package store keeps everything the central knows in PostgreSQL with TimescaleDB.
|
Package store keeps everything the central knows in PostgreSQL with TimescaleDB. |
|
store/storetest
Package storetest gives tests a fresh database, created from NETPROBE_TEST_DATABASE_URL and dropped at the end.
|
Package storetest gives tests a fresh database, created from NETPROBE_TEST_DATABASE_URL and dropped at the end. |
|
Package check owns what a check is: its protocols, its settings, the rules a valid check follows and its options.
|
Package check owns what a check is: its protocols, its settings, the rules a valid check follows and its options. |
|
Package edge is the agent: enrollment, the session with the central, the check scheduler and the local result buffer.
|
Package edge is the agent: enrollment, the session with the central, the check scheduler and the local result buffer. |
|
Package pki is the private certificate authority of the central: server and edge certificates, and the fingerprint edges pin.
|
Package pki is the private certificate authority of the central: server and edge certificates, and the fingerprint edges pin. |
|
Package probe measures the network: ICMP, TCP and UDP round trips, and Paris traceroutes.
|
Package probe measures the network: ICMP, TCP and UDP round trips, and Paris traceroutes. |
|
Package ratelimit limits events per key (an address, a user name) with a bounded memory: past the maximum, keys back to their initial state are dropped first (nothing is lost), then the least recently seen.
|
Package ratelimit limits events per key (an address, a user name) with a bounded memory: past the maximum, keys back to their initial state are dropped first (nothing is lost), then the least recently seen. |
|
Package stats summarizes round-trip samples: min, average, max, standard deviation, RFC 3550 jitter, loss and voice quality (MOS).
|
Package stats summarizes round-trip samples: min, average, max, standard deviation, RFC 3550 jitter, loss and voice quality (MOS). |
|
Package stunclient asks the STUN server of the central for the public address of the edge, with short-term credentials.
|
Package stunclient asks the STUN server of the central for the public address of the edge, with short-term credentials. |
|
Package version holds the build information, set at link time:
|
Package version holds the build information, set at link time: |
Click to show internal directories.
Click to hide internal directories.