README
¶
PMM 2.x APIs.
All generated files (Go code, Swagger spec, documentation) are already stored in this repository.
Browsing documentation
- Generate TLS certificate for
nginxfor local testing (once):
brew install mkcert
mkcert -install
make cert
- Serve API documentation with
nginx:
make serve
Updating APIs
-
Edit
.protofiles. Do not edit Swagger,.pb.go,.pb.gw.go. You can usemake cleanto remove all generated files. -
Install
prototooland fillvendor/(once):
make init
- Generate files:
make gen
Alertmanager
alertmanager/openapi.yaml is copied from https://github.com/prometheus/alertmanager/blob/master/api/v2/openapi.yaml.
Then Swagger client is generated using make gen-alertmanager.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agentlocalpb is a reverse proxy.
|
Package agentlocalpb is a reverse proxy. |
|
Package agentpb contains pmm-agent<->pmm-managed protocol messages and helpers.
|
Package agentpb contains pmm-agent<->pmm-managed protocol messages and helpers. |
|
alertmanager
|
|
|
Package inventorypb is a reverse proxy.
|
Package inventorypb is a reverse proxy. |
|
Package managementpb is a reverse proxy.
|
Package managementpb is a reverse proxy. |
|
Package qanpb is a reverse proxy.
|
Package qanpb is a reverse proxy. |
|
Package serverpb is a reverse proxy.
|
Package serverpb is a reverse proxy. |
Click to show internal directories.
Click to hide internal directories.