diff --git a/Gopkg.lock b/Gopkg.lock index 2f8e241b63..bbd64e7b83 100644 --- a/Gopkg.lock +++ b/Gopkg.lock @@ -9,6 +9,14 @@ pruneopts = "NUT" revision = "fcb4a6205bdc6ce526f359ae5eae5fb6ded53916" +[[projects]] + branch = "master" + digest = "1:d71d643ff29ed3a7b90d76bbff56ac47a0d41e51b4572fdf898374e059b88932" + name = "github.com/Percona-Lab/swagger-order" + packages = ["."] + pruneopts = "NUT" + revision = "166b3973d026e2e2c2428cc581f82772c9ea9025" + [[projects]] digest = "1:0a111edd8693fd977f42a0c4f199a0efb13c20aec9da99ad8830c7bb6a87e8d6" name = "github.com/PuerkitoBio/purell" @@ -25,6 +33,25 @@ pruneopts = "NUT" revision = "de5bf2ad457846296e2031421a34e2568e304e35" +[[projects]] + branch = "master" + digest = "1:f3793f8a708522400cef1dba23385e901aede5519f68971fd69938ef330b07a1" + name = "github.com/alecthomas/template" + packages = [ + ".", + "parse", + ] + pruneopts = "NUT" + revision = "fb15b899a75114aa79cc930e33c46b577cc664b1" + +[[projects]] + branch = "master" + digest = "1:278f733beeec2d654fc7412dbfa2dff194245e13c720bef8d4e284e0e25708f5" + name = "github.com/alecthomas/units" + packages = ["."] + pruneopts = "NUT" + revision = "f65c72e2690dc4b403c8bd637baf4611cd4c069b" + [[projects]] digest = "1:5a23cd3a5496a0b2da7e3b348d14e77b11a210738c398200d7d6f04ea8cf3bd8" name = "github.com/asaskevich/govalidator" @@ -169,7 +196,7 @@ version = "v1.8.0" [[projects]] - digest = "1:544ceb3cc5525ccf8327b03e753ac270dbd017dd22f40e17e159b2060224dd73" + digest = "1:6be2569487d6d326925caa1972d14b754704f440bb190d85319040e8361d72ec" name = "github.com/go-swagger/go-swagger" packages = [ ".", @@ -183,8 +210,9 @@ "scan", ] pruneopts = "NUT" - revision = "cf3fb25e7a4f340882908c5386ba4f22647e93da" - version = "v0.20.1" + revision = "487dd4291c23e66558fa5b3711fc67c18513ad5a" + source = "github.com/Percona-Lab/go-swagger" + version = "v0.20.1-percona2" [[projects]] digest = "1:e03281d7cc8219cf71346a4bc5d43f4095ce568675b61fb14fdd10ef5e38efa0" @@ -282,6 +310,14 @@ revision = "8cb6e5b959231cc1119e43259c4a608f9c51a241" version = "v1.0.0" +[[projects]] + branch = "master" + digest = "1:bcfbbca3e8f076027ea25d08da838dc868b0b93497c3c5a4f96d107c9f62557e" + name = "github.com/iancoleman/orderedmap" + packages = ["."] + pruneopts = "NUT" + revision = "ac98e3ecb4b017efb5c5d0fc075c2ded1f5d500d" + [[projects]] digest = "1:d0fbb40af7faf9cc62d1728be5fdd140ae17ce6e2aac6371971a0a6a2cc139d3" name = "github.com/jessevdk/go-flags" @@ -603,18 +639,27 @@ version = "v1.23.1" [[projects]] - digest = "1:18108594151654e9e696b27b181b953f9a90b16bf14d253dd1b397b025a1487f" + digest = "1:22b2dee6f30bc8601f087449a2a819df8388e54e9547349c658f14d8f8c590f2" + name = "gopkg.in/alecthomas/kingpin.v2" + packages = ["."] + pruneopts = "NUT" + revision = "947dcec5ba9c011838740e680966fd7087a71d0d" + version = "v2.2.6" + +[[projects]] + digest = "1:c0ce856ee6874fc944d5ee7ceb6c374321e027287c73a33b4c5fad666aedb3ea" name = "gopkg.in/yaml.v2" packages = ["."] pruneopts = "NUT" - revision = "51d6538a90f86fe93ac480b35f37b2be17fef232" - version = "v2.2.2" + revision = "bb4e33bf68bf89cad44d386192cbed201f35b241" + version = "v2.2.3" [solve-meta] analyzer-name = "dep" analyzer-version = 1 input-imports = [ "github.com/BurntSushi/go-sumtype", + "github.com/Percona-Lab/swagger-order", "github.com/go-openapi/errors", "github.com/go-openapi/runtime", "github.com/go-openapi/runtime/client", diff --git a/Gopkg.toml b/Gopkg.toml index d421d62320..b6e3edb714 100644 --- a/Gopkg.toml +++ b/Gopkg.toml @@ -6,6 +6,7 @@ required = [ "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger", "github.com/go-swagger/go-swagger/cmd/swagger", "github.com/BurntSushi/go-sumtype", + "github.com/Percona-Lab/swagger-order", # require key dependencies explicitly to make dep work "github.com/golang/protobuf/proto", @@ -44,7 +45,8 @@ required = [ version = "=1.11.1" [[constraint]] name = "github.com/go-swagger/go-swagger" - version = "=0.20.1" + source = "github.com/Percona-Lab/go-swagger" + version = "=0.20.1-percona2" # TODO switch to upstream as soon as https://github.com/go-swagger/go-swagger/pull/2074 is released. [[constraint]] name = "github.com/sirupsen/logrus" version = "=1.4.2" diff --git a/api/Makefile b/api/Makefile index 9764fabcaa..c478bbab6a 100644 --- a/api/Makefile +++ b/api/Makefile @@ -19,6 +19,7 @@ gen: clean ## Generate files. ../vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway \ ../vendor/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger \ ../vendor/github.com/go-swagger/go-swagger/cmd/swagger \ + ../vendor/github.com/Percona-Lab/swagger-order \ ../vendor/github.com/BurntSushi/go-sumtype # generated by ./prototool break descriptor-set . -o v2.0.0.descriptor @@ -28,7 +29,7 @@ gen: clean ## Generate files. for API in agentlocalpb serverpb inventorypb managementpb qanpb ; do \ set -x ; \ - swagger mixin $$API/json/header.json $$API/*.swagger.json --output=$$API/json/$$API.json ; \ + swagger mixin $$API/json/header.json $$API/*.swagger.json --output=$$API/json/$$API.json --keep-spec-order; \ swagger flatten --with-flatten=expand --with-flatten=remove-unused $$API/json/$$API.json --output=$$API/json/$$API.json ; \ swagger validate $$API/json/$$API.json ; \ swagger generate client --with-flatten=expand --with-flatten=remove-unused --spec=$$API/json/$$API.json --target=$$API/json \ @@ -50,6 +51,8 @@ gen: clean ## Generate files. qanpb/json/qanpb.json swagger validate swagger/swagger.json + swagger-order --output=swagger/swagger.json swagger/swagger.json + make clean_swagger go fmt ../... go-sumtype ../... diff --git a/api/agentlocalpb/json/agentlocalpb.json b/api/agentlocalpb/json/agentlocalpb.json index 01733235e1..4900bb0ca5 100644 --- a/api/agentlocalpb/json/agentlocalpb.json +++ b/api/agentlocalpb/json/agentlocalpb.json @@ -81,7 +81,8 @@ "get_network_info": { "description": "Returns network info (latency and clock_drift) if true.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 } } } @@ -94,7 +95,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "agents_info": { "type": "array", @@ -103,7 +105,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "agent_type": { "description": "AgentType describes supported Agent types.", @@ -137,14 +140,17 @@ ] } } - } + }, + "x-order": 3 }, "config_filepath": { "description": "Config file path if pmm-agent was started with one.", - "type": "string" + "type": "string", + "x-order": 4 }, "runs_on_node_id": { - "type": "string" + "type": "string", + "x-order": 1 }, "server_info": { "description": "ServerInfo contains information about the PMM Server.", @@ -152,29 +158,35 @@ "properties": { "clock_drift": { "description": "Clock drift from PMM Server (if agent is connected).", - "type": "string" + "type": "string", + "x-order": 5 }, "connected": { "description": "True if pmm-agent is currently connected to the server.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "insecure_tls": { "description": "PMM Server's TLS certificate validation should be skipped if true.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "latency": { "description": "Ping time from pmm-agent to pmm-managed (if agent is connected).", - "type": "string" + "type": "string", + "x-order": 4 }, "url": { "description": "PMM Server URL in a form https://HOST:PORT/.", - "type": "string" + "type": "string", + "x-order": 0 }, "version": { "description": "PMM Server version (if agent is connected).", - "type": "string" + "type": "string", + "x-order": 3 } } } diff --git a/api/agentlocalpb/json/client/agent_local/status_responses.go b/api/agentlocalpb/json/client/agent_local/status_responses.go index a30d51315c..6f18cfdb6c 100644 --- a/api/agentlocalpb/json/client/agent_local/status_responses.go +++ b/api/agentlocalpb/json/client/agent_local/status_responses.go @@ -382,15 +382,15 @@ type StatusOKBody struct { // agent id AgentID string `json:"agent_id,omitempty"` + // runs on node id + RunsOnNodeID string `json:"runs_on_node_id,omitempty"` + // agents info AgentsInfo []*AgentsInfoItems0 `json:"agents_info"` // Config file path if pmm-agent was started with one. ConfigFilepath string `json:"config_filepath,omitempty"` - // runs on node id - RunsOnNodeID string `json:"runs_on_node_id,omitempty"` - // server info ServerInfo *StatusOKBodyServerInfo `json:"server_info,omitempty"` } @@ -479,23 +479,23 @@ swagger:model StatusOKBodyServerInfo */ type StatusOKBodyServerInfo struct { - // Clock drift from PMM Server (if agent is connected). - ClockDrift string `json:"clock_drift,omitempty"` + // PMM Server URL in a form https://HOST:PORT/. + URL string `json:"url,omitempty"` + + // PMM Server's TLS certificate validation should be skipped if true. + InsecureTLS bool `json:"insecure_tls,omitempty"` // True if pmm-agent is currently connected to the server. Connected bool `json:"connected,omitempty"` - // PMM Server's TLS certificate validation should be skipped if true. - InsecureTLS bool `json:"insecure_tls,omitempty"` + // PMM Server version (if agent is connected). + Version string `json:"version,omitempty"` // Ping time from pmm-agent to pmm-managed (if agent is connected). Latency string `json:"latency,omitempty"` - // PMM Server URL in a form https://HOST:PORT/. - URL string `json:"url,omitempty"` - - // PMM Server version (if agent is connected). - Version string `json:"version,omitempty"` + // Clock drift from PMM Server (if agent is connected). + ClockDrift string `json:"clock_drift,omitempty"` } // Validate validates this status OK body server info diff --git a/api/inventorypb/json/client/agents/add_mongo_db_exporter_responses.go b/api/inventorypb/json/client/agents/add_mongo_db_exporter_responses.go index 91782a5c0b..afecdca5ec 100644 --- a/api/inventorypb/json/client/agents/add_mongo_db_exporter_responses.go +++ b/api/inventorypb/json/client/agents/add_mongo_db_exporter_responses.go @@ -124,20 +124,17 @@ swagger:model AddMongoDBExporterBody */ type AddMongoDBExporterBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // MongoDB password for scraping metrics. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // MongoDB username for scraping metrics. + Username string `json:"username,omitempty"` + + // MongoDB password for scraping metrics. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -145,8 +142,11 @@ type AddMongoDBExporterBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MongoDB username for scraping metrics. - Username string `json:"username,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add mongo DB exporter body @@ -277,21 +277,30 @@ type AddMongoDBExporterOKBodyMongodbExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -301,15 +310,6 @@ type AddMongoDBExporterOKBodyMongodbExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add mongo DB exporter OK body mongodb exporter diff --git a/api/inventorypb/json/client/agents/add_my_s_q_ld_exporter_responses.go b/api/inventorypb/json/client/agents/add_my_s_q_ld_exporter_responses.go index fd0463a1c4..73ea876a8c 100644 --- a/api/inventorypb/json/client/agents/add_my_s_q_ld_exporter_responses.go +++ b/api/inventorypb/json/client/agents/add_my_s_q_ld_exporter_responses.go @@ -124,20 +124,17 @@ swagger:model AddMySQLdExporterBody */ type AddMySQLdExporterBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // MySQL password for scraping metrics. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // MySQL password for scraping metrics. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -145,8 +142,11 @@ type AddMySQLdExporterBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add my s q ld exporter body @@ -277,21 +277,30 @@ type AddMySQLdExporterOKBodyMysqldExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -301,15 +310,6 @@ type AddMySQLdExporterOKBodyMysqldExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add my s q ld exporter OK body mysqld exporter diff --git a/api/inventorypb/json/client/agents/add_node_exporter_responses.go b/api/inventorypb/json/client/agents/add_node_exporter_responses.go index d4f598eaa3..6b65f8e0ec 100644 --- a/api/inventorypb/json/client/agents/add_node_exporter_responses.go +++ b/api/inventorypb/json/client/agents/add_node_exporter_responses.go @@ -124,11 +124,11 @@ swagger:model AddNodeExporterBody */ type AddNodeExporterBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add node exporter body @@ -259,18 +259,18 @@ type AddNodeExporterOKBodyNodeExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Listen port for scraping metrics. ListenPort int64 `json:"listen_port,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. diff --git a/api/inventorypb/json/client/agents/add_pmm_agent_responses.go b/api/inventorypb/json/client/agents/add_pmm_agent_responses.go index 4c7fe1f520..0cdd287b00 100644 --- a/api/inventorypb/json/client/agents/add_pmm_agent_responses.go +++ b/api/inventorypb/json/client/agents/add_pmm_agent_responses.go @@ -122,11 +122,11 @@ swagger:model AddPMMAgentBody */ type AddPMMAgentBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Node identifier where this instance runs. RunsOnNodeID string `json:"runs_on_node_id,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add PMM agent body @@ -257,14 +257,14 @@ type AddPMMAgentOKBodyPMMAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // True if Agent is running and connected to pmm-managed. - Connected bool `json:"connected,omitempty"` + // Node identifier where this instance runs. + RunsOnNodeID string `json:"runs_on_node_id,omitempty"` // Custom user-assigned labels. CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Node identifier where this instance runs. - RunsOnNodeID string `json:"runs_on_node_id,omitempty"` + // True if Agent is running and connected to pmm-managed. + Connected bool `json:"connected,omitempty"` } // Validate validates this add PMM agent OK body PMM agent diff --git a/api/inventorypb/json/client/agents/add_postgres_exporter_responses.go b/api/inventorypb/json/client/agents/add_postgres_exporter_responses.go index 9183bd5e71..7e27a83e76 100644 --- a/api/inventorypb/json/client/agents/add_postgres_exporter_responses.go +++ b/api/inventorypb/json/client/agents/add_postgres_exporter_responses.go @@ -124,20 +124,17 @@ swagger:model AddPostgresExporterBody */ type AddPostgresExporterBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // PostgreSQL password for scraping metrics. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // PostgreSQL password for scraping metrics. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -145,8 +142,11 @@ type AddPostgresExporterBody struct { // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add postgres exporter body @@ -277,21 +277,30 @@ type AddPostgresExporterOKBodyPostgresExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -301,15 +310,6 @@ type AddPostgresExporterOKBodyPostgresExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add postgres exporter OK body postgres exporter diff --git a/api/inventorypb/json/client/agents/add_proxy_sql_exporter_responses.go b/api/inventorypb/json/client/agents/add_proxy_sql_exporter_responses.go index e5b242be46..d4dfa76f4f 100644 --- a/api/inventorypb/json/client/agents/add_proxy_sql_exporter_responses.go +++ b/api/inventorypb/json/client/agents/add_proxy_sql_exporter_responses.go @@ -124,20 +124,17 @@ swagger:model AddProxySQLExporterBody */ type AddProxySQLExporterBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // ProxySQL password for scraping metrics. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // ProxySQL password for scraping metrics. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -145,8 +142,11 @@ type AddProxySQLExporterBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add proxy SQL exporter body @@ -277,21 +277,30 @@ type AddProxySQLExporterOKBodyProxysqlExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -301,15 +310,6 @@ type AddProxySQLExporterOKBodyProxysqlExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add proxy SQL exporter OK body proxysql exporter diff --git a/api/inventorypb/json/client/agents/add_qan_mongo_db_profiler_agent_responses.go b/api/inventorypb/json/client/agents/add_qan_mongo_db_profiler_agent_responses.go index 33fd21ae16..19a364a2b4 100644 --- a/api/inventorypb/json/client/agents/add_qan_mongo_db_profiler_agent_responses.go +++ b/api/inventorypb/json/client/agents/add_qan_mongo_db_profiler_agent_responses.go @@ -124,20 +124,17 @@ swagger:model AddQANMongoDBProfilerAgentBody */ type AddQANMongoDBProfilerAgentBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // MongoDB password for getting profile data. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // MongoDB username for getting profile data. + Username string `json:"username,omitempty"` + + // MongoDB password for getting profile data. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -145,8 +142,11 @@ type AddQANMongoDBProfilerAgentBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MongoDB username for getting profile data. - Username string `json:"username,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add QAN mongo DB profiler agent body @@ -277,18 +277,27 @@ type AddQANMongoDBProfilerAgentOKBodyQANMongodbProfilerAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for getting profiler data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -298,15 +307,6 @@ type AddQANMongoDBProfilerAgentOKBodyQANMongodbProfilerAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for getting profiler data. - Username string `json:"username,omitempty"` } // Validate validates this add QAN mongo DB profiler agent OK body QAN mongodb profiler agent diff --git a/api/inventorypb/json/client/agents/add_qan_my_sql_perf_schema_agent_responses.go b/api/inventorypb/json/client/agents/add_qan_my_sql_perf_schema_agent_responses.go index c722a21743..ac523f5ce8 100644 --- a/api/inventorypb/json/client/agents/add_qan_my_sql_perf_schema_agent_responses.go +++ b/api/inventorypb/json/client/agents/add_qan_my_sql_perf_schema_agent_responses.go @@ -124,23 +124,17 @@ swagger:model AddQANMySQLPerfSchemaAgentBody */ type AddQANMySQLPerfSchemaAgentBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Disable query examples. - DisableQueryExamples bool `json:"disable_query_examples,omitempty"` - - // MySQL password for getting performance data. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // MySQL password for getting performance data. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -148,8 +142,14 @@ type AddQANMySQLPerfSchemaAgentBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` + // Disable query examples. + DisableQueryExamples bool `json:"disable_query_examples,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add QAN my SQL perf schema agent body @@ -280,20 +280,29 @@ type AddQANMySQLPerfSchemaAgentOKBodyQANMysqlPerfschemaAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` + + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // True if query examples are disabled. QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -304,15 +313,6 @@ type AddQANMySQLPerfSchemaAgentOKBodyQANMysqlPerfschemaAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this add QAN my SQL perf schema agent OK body QAN mysql perfschema agent diff --git a/api/inventorypb/json/client/agents/add_qan_my_sql_slowlog_agent_responses.go b/api/inventorypb/json/client/agents/add_qan_my_sql_slowlog_agent_responses.go index daa8b96d80..e080d7bf2d 100644 --- a/api/inventorypb/json/client/agents/add_qan_my_sql_slowlog_agent_responses.go +++ b/api/inventorypb/json/client/agents/add_qan_my_sql_slowlog_agent_responses.go @@ -124,27 +124,17 @@ swagger:model AddQANMySQLSlowlogAgentBody */ type AddQANMySQLSlowlogAgentBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Disable query examples. - DisableQueryExamples bool `json:"disable_query_examples,omitempty"` - - // Rotate slowlog file at this size if > 0. - // Use zero or negative value to disable rotation. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` - - // MySQL password for getting slowlog data. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // MySQL username for getting slowlog data. + Username string `json:"username,omitempty"` + + // MySQL password for getting slowlog data. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -152,8 +142,18 @@ type AddQANMySQLSlowlogAgentBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MySQL username for getting slowlog data. - Username string `json:"username,omitempty"` + // Disable query examples. + DisableQueryExamples bool `json:"disable_query_examples,omitempty"` + + // Rotate slowlog file at this size if > 0. + // Use zero or negative value to disable rotation. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add QAN my SQL slowlog agent body @@ -284,23 +284,32 @@ type AddQANMySQLSlowlogAgentOKBodyQANMysqlSlowlogAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Slowlog file is rotated at this size if > 0. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // query examples disabled QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Slowlog file is rotated at this size if > 0. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -311,15 +320,6 @@ type AddQANMySQLSlowlogAgentOKBodyQANMysqlSlowlogAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this add QAN my SQL slowlog agent OK body QAN mysql slowlog agent diff --git a/api/inventorypb/json/client/agents/add_qan_postgre_sql_pg_statements_agent_responses.go b/api/inventorypb/json/client/agents/add_qan_postgre_sql_pg_statements_agent_responses.go index 3b47cb4b28..841d3f0f2c 100644 --- a/api/inventorypb/json/client/agents/add_qan_postgre_sql_pg_statements_agent_responses.go +++ b/api/inventorypb/json/client/agents/add_qan_postgre_sql_pg_statements_agent_responses.go @@ -124,20 +124,17 @@ swagger:model AddQANPostgreSQLPgStatementsAgentBody */ type AddQANPostgreSQLPgStatementsAgentBody struct { - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // PostgreSQL password for getting pg stat statements data. - Password string `json:"password,omitempty"` - // The pmm-agent identifier which runs this instance. PMMAgentID string `json:"pmm_agent_id,omitempty"` // Service identifier. ServiceID string `json:"service_id,omitempty"` - // Skip connection check. - SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // PostgreSQL username for getting pg stat statements data. + Username string `json:"username,omitempty"` + + // PostgreSQL password for getting pg stat statements data. + Password string `json:"password,omitempty"` // Use TLS for database connections. TLS bool `json:"tls,omitempty"` @@ -145,8 +142,11 @@ type AddQANPostgreSQLPgStatementsAgentBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // PostgreSQL username for getting pg stat statements data. - Username string `json:"username,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Skip connection check. + SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` } // Validate validates this add QAN postgre SQL pg statements agent body @@ -277,18 +277,27 @@ type AddQANPostgreSQLPgStatementsAgentOKBodyQANPostgresqlPgstatementsAgent struc // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for getting pg stat statements data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -298,15 +307,6 @@ type AddQANPostgreSQLPgStatementsAgentOKBodyQANPostgresqlPgstatementsAgent struc // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for getting pg stat statements data. - Username string `json:"username,omitempty"` } // Validate validates this add QAN postgre SQL pg statements agent OK body QAN postgresql pgstatements agent diff --git a/api/inventorypb/json/client/agents/change_mongo_db_exporter_responses.go b/api/inventorypb/json/client/agents/change_mongo_db_exporter_responses.go index 6c4a622908..a17ca28ce7 100644 --- a/api/inventorypb/json/client/agents/change_mongo_db_exporter_responses.go +++ b/api/inventorypb/json/client/agents/change_mongo_db_exporter_responses.go @@ -286,21 +286,30 @@ type ChangeMongoDBExporterOKBodyMongodbExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -310,15 +319,6 @@ type ChangeMongoDBExporterOKBodyMongodbExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this change mongo DB exporter OK body mongodb exporter @@ -413,14 +413,14 @@ swagger:model ChangeMongoDBExporterParamsBodyCommon */ type ChangeMongoDBExporterParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_my_s_q_ld_exporter_responses.go b/api/inventorypb/json/client/agents/change_my_s_q_ld_exporter_responses.go index d9d8e50cb6..b75bfab3e3 100644 --- a/api/inventorypb/json/client/agents/change_my_s_q_ld_exporter_responses.go +++ b/api/inventorypb/json/client/agents/change_my_s_q_ld_exporter_responses.go @@ -286,21 +286,30 @@ type ChangeMySQLdExporterOKBodyMysqldExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -310,15 +319,6 @@ type ChangeMySQLdExporterOKBodyMysqldExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this change my s q ld exporter OK body mysqld exporter @@ -413,14 +413,14 @@ swagger:model ChangeMySQLdExporterParamsBodyCommon */ type ChangeMySQLdExporterParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_node_exporter_responses.go b/api/inventorypb/json/client/agents/change_node_exporter_responses.go index 53405f166c..90711b9baa 100644 --- a/api/inventorypb/json/client/agents/change_node_exporter_responses.go +++ b/api/inventorypb/json/client/agents/change_node_exporter_responses.go @@ -286,18 +286,18 @@ type ChangeNodeExporterOKBodyNodeExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Listen port for scraping metrics. ListenPort int64 `json:"listen_port,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -401,14 +401,14 @@ swagger:model ChangeNodeExporterParamsBodyCommon */ type ChangeNodeExporterParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_postgres_exporter_responses.go b/api/inventorypb/json/client/agents/change_postgres_exporter_responses.go index b5353917a8..9c0d5610ca 100644 --- a/api/inventorypb/json/client/agents/change_postgres_exporter_responses.go +++ b/api/inventorypb/json/client/agents/change_postgres_exporter_responses.go @@ -286,21 +286,30 @@ type ChangePostgresExporterOKBodyPostgresExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -310,15 +319,6 @@ type ChangePostgresExporterOKBodyPostgresExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this change postgres exporter OK body postgres exporter @@ -413,14 +413,14 @@ swagger:model ChangePostgresExporterParamsBodyCommon */ type ChangePostgresExporterParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_proxy_sql_exporter_responses.go b/api/inventorypb/json/client/agents/change_proxy_sql_exporter_responses.go index c1aa051c9a..07ecbfd322 100644 --- a/api/inventorypb/json/client/agents/change_proxy_sql_exporter_responses.go +++ b/api/inventorypb/json/client/agents/change_proxy_sql_exporter_responses.go @@ -286,21 +286,30 @@ type ChangeProxySQLExporterOKBodyProxysqlExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -310,15 +319,6 @@ type ChangeProxySQLExporterOKBodyProxysqlExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this change proxy SQL exporter OK body proxysql exporter @@ -413,14 +413,14 @@ swagger:model ChangeProxySQLExporterParamsBodyCommon */ type ChangeProxySQLExporterParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_qan_mongo_db_profiler_agent_responses.go b/api/inventorypb/json/client/agents/change_qan_mongo_db_profiler_agent_responses.go index 28d29cfb49..6e4f186f08 100644 --- a/api/inventorypb/json/client/agents/change_qan_mongo_db_profiler_agent_responses.go +++ b/api/inventorypb/json/client/agents/change_qan_mongo_db_profiler_agent_responses.go @@ -286,18 +286,27 @@ type ChangeQANMongoDBProfilerAgentOKBodyQANMongodbProfilerAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for getting profiler data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -307,15 +316,6 @@ type ChangeQANMongoDBProfilerAgentOKBodyQANMongodbProfilerAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for getting profiler data. - Username string `json:"username,omitempty"` } // Validate validates this change QAN mongo DB profiler agent OK body QAN mongodb profiler agent @@ -410,14 +410,14 @@ swagger:model ChangeQANMongoDBProfilerAgentParamsBodyCommon */ type ChangeQANMongoDBProfilerAgentParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_qan_my_sql_perf_schema_agent_responses.go b/api/inventorypb/json/client/agents/change_qan_my_sql_perf_schema_agent_responses.go index 46c8e57083..17944c5f22 100644 --- a/api/inventorypb/json/client/agents/change_qan_my_sql_perf_schema_agent_responses.go +++ b/api/inventorypb/json/client/agents/change_qan_my_sql_perf_schema_agent_responses.go @@ -286,20 +286,29 @@ type ChangeQANMySQLPerfSchemaAgentOKBodyQANMysqlPerfschemaAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` + + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // True if query examples are disabled. QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -310,15 +319,6 @@ type ChangeQANMySQLPerfSchemaAgentOKBodyQANMysqlPerfschemaAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this change QAN my SQL perf schema agent OK body QAN mysql perfschema agent @@ -413,14 +413,14 @@ swagger:model ChangeQANMySQLPerfSchemaAgentParamsBodyCommon */ type ChangeQANMySQLPerfSchemaAgentParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_qan_my_sql_slowlog_agent_responses.go b/api/inventorypb/json/client/agents/change_qan_my_sql_slowlog_agent_responses.go index 6fea0898dd..d728427bd1 100644 --- a/api/inventorypb/json/client/agents/change_qan_my_sql_slowlog_agent_responses.go +++ b/api/inventorypb/json/client/agents/change_qan_my_sql_slowlog_agent_responses.go @@ -286,23 +286,32 @@ type ChangeQANMySQLSlowlogAgentOKBodyQANMysqlSlowlogAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Slowlog file is rotated at this size if > 0. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // query examples disabled QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Slowlog file is rotated at this size if > 0. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -313,15 +322,6 @@ type ChangeQANMySQLSlowlogAgentOKBodyQANMysqlSlowlogAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this change QAN my SQL slowlog agent OK body QAN mysql slowlog agent @@ -416,14 +416,14 @@ swagger:model ChangeQANMySQLSlowlogAgentParamsBodyCommon */ type ChangeQANMySQLSlowlogAgentParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/change_qan_postgre_sql_pg_statements_agent_responses.go b/api/inventorypb/json/client/agents/change_qan_postgre_sql_pg_statements_agent_responses.go index a6acd3fa61..1dafb629df 100644 --- a/api/inventorypb/json/client/agents/change_qan_postgre_sql_pg_statements_agent_responses.go +++ b/api/inventorypb/json/client/agents/change_qan_postgre_sql_pg_statements_agent_responses.go @@ -286,18 +286,27 @@ type ChangeQANPostgreSQLPgStatementsAgentOKBodyQANPostgresqlPgstatementsAgent st // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for getting pg stat statements data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -307,15 +316,6 @@ type ChangeQANPostgreSQLPgStatementsAgentOKBodyQANPostgresqlPgstatementsAgent st // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for getting pg stat statements data. - Username string `json:"username,omitempty"` } // Validate validates this change QAN postgre SQL pg statements agent OK body QAN postgresql pgstatements agent @@ -410,14 +410,14 @@ swagger:model ChangeQANPostgreSQLPgStatementsAgentParamsBodyCommon */ type ChangeQANPostgreSQLPgStatementsAgentParamsBodyCommon struct { - // Replace all custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Enable this Agent. Can't be used with disabled. + Enable bool `json:"enable,omitempty"` // Disable this Agent. Can't be used with enabled. Disable bool `json:"disable,omitempty"` - // Enable this Agent. Can't be used with disabled. - Enable bool `json:"enable,omitempty"` + // Replace all custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Remove all custom user-assigned labels. RemoveCustomLabels bool `json:"remove_custom_labels,omitempty"` diff --git a/api/inventorypb/json/client/agents/get_agent_responses.go b/api/inventorypb/json/client/agents/get_agent_responses.go index 10d7352626..57e4f97609 100644 --- a/api/inventorypb/json/client/agents/get_agent_responses.go +++ b/api/inventorypb/json/client/agents/get_agent_responses.go @@ -481,21 +481,30 @@ type GetAgentOKBodyMongodbExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -505,15 +514,6 @@ type GetAgentOKBodyMongodbExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body mongodb exporter @@ -611,21 +611,30 @@ type GetAgentOKBodyMysqldExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -635,15 +644,6 @@ type GetAgentOKBodyMysqldExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body mysqld exporter @@ -741,18 +741,18 @@ type GetAgentOKBodyNodeExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Listen port for scraping metrics. ListenPort int64 `json:"listen_port,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -859,14 +859,14 @@ type GetAgentOKBodyPMMAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // True if Agent is running and connected to pmm-managed. - Connected bool `json:"connected,omitempty"` + // Node identifier where this instance runs. + RunsOnNodeID string `json:"runs_on_node_id,omitempty"` // Custom user-assigned labels. CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Node identifier where this instance runs. - RunsOnNodeID string `json:"runs_on_node_id,omitempty"` + // True if Agent is running and connected to pmm-managed. + Connected bool `json:"connected,omitempty"` } // Validate validates this get agent OK body PMM agent @@ -900,21 +900,30 @@ type GetAgentOKBodyPostgresExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -924,15 +933,6 @@ type GetAgentOKBodyPostgresExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body postgres exporter @@ -1030,21 +1030,30 @@ type GetAgentOKBodyProxysqlExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1054,15 +1063,6 @@ type GetAgentOKBodyProxysqlExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body proxysql exporter @@ -1160,18 +1160,27 @@ type GetAgentOKBodyQANMongodbProfilerAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for getting profiler data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1181,15 +1190,6 @@ type GetAgentOKBodyQANMongodbProfilerAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for getting profiler data. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body QAN mongodb profiler agent @@ -1287,20 +1287,29 @@ type GetAgentOKBodyQANMysqlPerfschemaAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` + + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // True if query examples are disabled. QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -1311,15 +1320,6 @@ type GetAgentOKBodyQANMysqlPerfschemaAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body QAN mysql perfschema agent @@ -1417,23 +1417,32 @@ type GetAgentOKBodyQANMysqlSlowlogAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Slowlog file is rotated at this size if > 0. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // query examples disabled QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Slowlog file is rotated at this size if > 0. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -1444,15 +1453,6 @@ type GetAgentOKBodyQANMysqlSlowlogAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body QAN mysql slowlog agent @@ -1550,18 +1550,27 @@ type GetAgentOKBodyQANPostgresqlPgstatementsAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for getting pg stat statements data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1571,15 +1580,6 @@ type GetAgentOKBodyQANPostgresqlPgstatementsAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for getting pg stat statements data. - Username string `json:"username,omitempty"` } // Validate validates this get agent OK body QAN postgresql pgstatements agent diff --git a/api/inventorypb/json/client/agents/list_agents_responses.go b/api/inventorypb/json/client/agents/list_agents_responses.go index 848bd73a23..a40096f924 100644 --- a/api/inventorypb/json/client/agents/list_agents_responses.go +++ b/api/inventorypb/json/client/agents/list_agents_responses.go @@ -125,14 +125,14 @@ swagger:model ListAgentsBody */ type ListAgentsBody struct { - // Return only Agents that provide insights for that Node. - // Exactly one of these parameters should be present: pmm_agent_id, node_id, service_id. - NodeID string `json:"node_id,omitempty"` - // Return only Agents started by this pmm-agent. // Exactly one of these parameters should be present: pmm_agent_id, node_id, service_id. PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Return only Agents that provide insights for that Node. + // Exactly one of these parameters should be present: pmm_agent_id, node_id, service_id. + NodeID string `json:"node_id,omitempty"` + // Return only Agents that provide insights for that Service. // Exactly one of these parameters should be present: pmm_agent_id, node_id, service_id. ServiceID string `json:"service_id,omitempty"` @@ -204,17 +204,17 @@ swagger:model ListAgentsOKBody */ type ListAgentsOKBody struct { - // mongodb exporter - MongodbExporter []*MongodbExporterItems0 `json:"mongodb_exporter"` - - // mysqld exporter - MysqldExporter []*MysqldExporterItems0 `json:"mysqld_exporter"` + // pmm agent + PMMAgent []*PMMAgentItems0 `json:"pmm_agent"` // node exporter NodeExporter []*NodeExporterItems0 `json:"node_exporter"` - // pmm agent - PMMAgent []*PMMAgentItems0 `json:"pmm_agent"` + // mysqld exporter + MysqldExporter []*MysqldExporterItems0 `json:"mysqld_exporter"` + + // mongodb exporter + MongodbExporter []*MongodbExporterItems0 `json:"mongodb_exporter"` // postgres exporter PostgresExporter []*PostgresExporterItems0 `json:"postgres_exporter"` @@ -222,15 +222,15 @@ type ListAgentsOKBody struct { // proxysql exporter ProxysqlExporter []*ProxysqlExporterItems0 `json:"proxysql_exporter"` - // qan mongodb profiler agent - QANMongodbProfilerAgent []*QANMongodbProfilerAgentItems0 `json:"qan_mongodb_profiler_agent"` - // qan mysql perfschema agent QANMysqlPerfschemaAgent []*QANMysqlPerfschemaAgentItems0 `json:"qan_mysql_perfschema_agent"` // qan mysql slowlog agent QANMysqlSlowlogAgent []*QANMysqlSlowlogAgentItems0 `json:"qan_mysql_slowlog_agent"` + // qan mongodb profiler agent + QANMongodbProfilerAgent []*QANMongodbProfilerAgentItems0 `json:"qan_mongodb_profiler_agent"` + // qan postgresql pgstatements agent QANPostgresqlPgstatementsAgent []*QANPostgresqlPgstatementsAgentItems0 `json:"qan_postgresql_pgstatements_agent"` } @@ -239,19 +239,19 @@ type ListAgentsOKBody struct { func (o *ListAgentsOKBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateMongodbExporter(formats); err != nil { + if err := o.validatePMMAgent(formats); err != nil { res = append(res, err) } - if err := o.validateMysqldExporter(formats); err != nil { + if err := o.validateNodeExporter(formats); err != nil { res = append(res, err) } - if err := o.validateNodeExporter(formats); err != nil { + if err := o.validateMysqldExporter(formats); err != nil { res = append(res, err) } - if err := o.validatePMMAgent(formats); err != nil { + if err := o.validateMongodbExporter(formats); err != nil { res = append(res, err) } @@ -263,15 +263,15 @@ func (o *ListAgentsOKBody) Validate(formats strfmt.Registry) error { res = append(res, err) } - if err := o.validateQANMongodbProfilerAgent(formats); err != nil { + if err := o.validateQANMysqlPerfschemaAgent(formats); err != nil { res = append(res, err) } - if err := o.validateQANMysqlPerfschemaAgent(formats); err != nil { + if err := o.validateQANMysqlSlowlogAgent(formats); err != nil { res = append(res, err) } - if err := o.validateQANMysqlSlowlogAgent(formats); err != nil { + if err := o.validateQANMongodbProfilerAgent(formats); err != nil { res = append(res, err) } @@ -285,21 +285,21 @@ func (o *ListAgentsOKBody) Validate(formats strfmt.Registry) error { return nil } -func (o *ListAgentsOKBody) validateMongodbExporter(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validatePMMAgent(formats strfmt.Registry) error { - if swag.IsZero(o.MongodbExporter) { // not required + if swag.IsZero(o.PMMAgent) { // not required return nil } - for i := 0; i < len(o.MongodbExporter); i++ { - if swag.IsZero(o.MongodbExporter[i]) { // not required + for i := 0; i < len(o.PMMAgent); i++ { + if swag.IsZero(o.PMMAgent[i]) { // not required continue } - if o.MongodbExporter[i] != nil { - if err := o.MongodbExporter[i].Validate(formats); err != nil { + if o.PMMAgent[i] != nil { + if err := o.PMMAgent[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "mongodb_exporter" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "pmm_agent" + "." + strconv.Itoa(i)) } return err } @@ -310,21 +310,21 @@ func (o *ListAgentsOKBody) validateMongodbExporter(formats strfmt.Registry) erro return nil } -func (o *ListAgentsOKBody) validateMysqldExporter(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validateNodeExporter(formats strfmt.Registry) error { - if swag.IsZero(o.MysqldExporter) { // not required + if swag.IsZero(o.NodeExporter) { // not required return nil } - for i := 0; i < len(o.MysqldExporter); i++ { - if swag.IsZero(o.MysqldExporter[i]) { // not required + for i := 0; i < len(o.NodeExporter); i++ { + if swag.IsZero(o.NodeExporter[i]) { // not required continue } - if o.MysqldExporter[i] != nil { - if err := o.MysqldExporter[i].Validate(formats); err != nil { + if o.NodeExporter[i] != nil { + if err := o.NodeExporter[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "mysqld_exporter" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "node_exporter" + "." + strconv.Itoa(i)) } return err } @@ -335,21 +335,21 @@ func (o *ListAgentsOKBody) validateMysqldExporter(formats strfmt.Registry) error return nil } -func (o *ListAgentsOKBody) validateNodeExporter(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validateMysqldExporter(formats strfmt.Registry) error { - if swag.IsZero(o.NodeExporter) { // not required + if swag.IsZero(o.MysqldExporter) { // not required return nil } - for i := 0; i < len(o.NodeExporter); i++ { - if swag.IsZero(o.NodeExporter[i]) { // not required + for i := 0; i < len(o.MysqldExporter); i++ { + if swag.IsZero(o.MysqldExporter[i]) { // not required continue } - if o.NodeExporter[i] != nil { - if err := o.NodeExporter[i].Validate(formats); err != nil { + if o.MysqldExporter[i] != nil { + if err := o.MysqldExporter[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "node_exporter" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "mysqld_exporter" + "." + strconv.Itoa(i)) } return err } @@ -360,21 +360,21 @@ func (o *ListAgentsOKBody) validateNodeExporter(formats strfmt.Registry) error { return nil } -func (o *ListAgentsOKBody) validatePMMAgent(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validateMongodbExporter(formats strfmt.Registry) error { - if swag.IsZero(o.PMMAgent) { // not required + if swag.IsZero(o.MongodbExporter) { // not required return nil } - for i := 0; i < len(o.PMMAgent); i++ { - if swag.IsZero(o.PMMAgent[i]) { // not required + for i := 0; i < len(o.MongodbExporter); i++ { + if swag.IsZero(o.MongodbExporter[i]) { // not required continue } - if o.PMMAgent[i] != nil { - if err := o.PMMAgent[i].Validate(formats); err != nil { + if o.MongodbExporter[i] != nil { + if err := o.MongodbExporter[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "pmm_agent" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "mongodb_exporter" + "." + strconv.Itoa(i)) } return err } @@ -435,21 +435,21 @@ func (o *ListAgentsOKBody) validateProxysqlExporter(formats strfmt.Registry) err return nil } -func (o *ListAgentsOKBody) validateQANMongodbProfilerAgent(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validateQANMysqlPerfschemaAgent(formats strfmt.Registry) error { - if swag.IsZero(o.QANMongodbProfilerAgent) { // not required + if swag.IsZero(o.QANMysqlPerfschemaAgent) { // not required return nil } - for i := 0; i < len(o.QANMongodbProfilerAgent); i++ { - if swag.IsZero(o.QANMongodbProfilerAgent[i]) { // not required + for i := 0; i < len(o.QANMysqlPerfschemaAgent); i++ { + if swag.IsZero(o.QANMysqlPerfschemaAgent[i]) { // not required continue } - if o.QANMongodbProfilerAgent[i] != nil { - if err := o.QANMongodbProfilerAgent[i].Validate(formats); err != nil { + if o.QANMysqlPerfschemaAgent[i] != nil { + if err := o.QANMysqlPerfschemaAgent[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "qan_mongodb_profiler_agent" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "qan_mysql_perfschema_agent" + "." + strconv.Itoa(i)) } return err } @@ -460,21 +460,21 @@ func (o *ListAgentsOKBody) validateQANMongodbProfilerAgent(formats strfmt.Regist return nil } -func (o *ListAgentsOKBody) validateQANMysqlPerfschemaAgent(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validateQANMysqlSlowlogAgent(formats strfmt.Registry) error { - if swag.IsZero(o.QANMysqlPerfschemaAgent) { // not required + if swag.IsZero(o.QANMysqlSlowlogAgent) { // not required return nil } - for i := 0; i < len(o.QANMysqlPerfschemaAgent); i++ { - if swag.IsZero(o.QANMysqlPerfschemaAgent[i]) { // not required + for i := 0; i < len(o.QANMysqlSlowlogAgent); i++ { + if swag.IsZero(o.QANMysqlSlowlogAgent[i]) { // not required continue } - if o.QANMysqlPerfschemaAgent[i] != nil { - if err := o.QANMysqlPerfschemaAgent[i].Validate(formats); err != nil { + if o.QANMysqlSlowlogAgent[i] != nil { + if err := o.QANMysqlSlowlogAgent[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "qan_mysql_perfschema_agent" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "qan_mysql_slowlog_agent" + "." + strconv.Itoa(i)) } return err } @@ -485,21 +485,21 @@ func (o *ListAgentsOKBody) validateQANMysqlPerfschemaAgent(formats strfmt.Regist return nil } -func (o *ListAgentsOKBody) validateQANMysqlSlowlogAgent(formats strfmt.Registry) error { +func (o *ListAgentsOKBody) validateQANMongodbProfilerAgent(formats strfmt.Registry) error { - if swag.IsZero(o.QANMysqlSlowlogAgent) { // not required + if swag.IsZero(o.QANMongodbProfilerAgent) { // not required return nil } - for i := 0; i < len(o.QANMysqlSlowlogAgent); i++ { - if swag.IsZero(o.QANMysqlSlowlogAgent[i]) { // not required + for i := 0; i < len(o.QANMongodbProfilerAgent); i++ { + if swag.IsZero(o.QANMongodbProfilerAgent[i]) { // not required continue } - if o.QANMysqlSlowlogAgent[i] != nil { - if err := o.QANMysqlSlowlogAgent[i].Validate(formats); err != nil { + if o.QANMongodbProfilerAgent[i] != nil { + if err := o.QANMongodbProfilerAgent[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listAgentsOk" + "." + "qan_mysql_slowlog_agent" + "." + strconv.Itoa(i)) + return ve.ValidateName("listAgentsOk" + "." + "qan_mongodb_profiler_agent" + "." + strconv.Itoa(i)) } return err } @@ -561,21 +561,30 @@ type MongodbExporterItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -585,15 +594,6 @@ type MongodbExporterItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this mongodb exporter items0 @@ -691,21 +691,30 @@ type MysqldExporterItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -715,15 +724,6 @@ type MysqldExporterItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this mysqld exporter items0 @@ -821,18 +821,18 @@ type NodeExporterItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Listen port for scraping metrics. ListenPort int64 `json:"listen_port,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -939,14 +939,14 @@ type PMMAgentItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // True if Agent is running and connected to pmm-managed. - Connected bool `json:"connected,omitempty"` + // Node identifier where this instance runs. + RunsOnNodeID string `json:"runs_on_node_id,omitempty"` // Custom user-assigned labels. CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Node identifier where this instance runs. - RunsOnNodeID string `json:"runs_on_node_id,omitempty"` + // True if Agent is running and connected to pmm-managed. + Connected bool `json:"connected,omitempty"` } // Validate validates this PMM agent items0 @@ -980,21 +980,30 @@ type PostgresExporterItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1004,15 +1013,6 @@ type PostgresExporterItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this postgres exporter items0 @@ -1110,21 +1110,30 @@ type ProxysqlExporterItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1134,15 +1143,6 @@ type ProxysqlExporterItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this proxysql exporter items0 @@ -1240,18 +1240,27 @@ type QANMongodbProfilerAgentItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for getting profiler data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1261,15 +1270,6 @@ type QANMongodbProfilerAgentItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for getting profiler data. - Username string `json:"username,omitempty"` } // Validate validates this QAN mongodb profiler agent items0 @@ -1367,20 +1367,29 @@ type QANMysqlPerfschemaAgentItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` + + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // True if query examples are disabled. QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -1391,15 +1400,6 @@ type QANMysqlPerfschemaAgentItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this QAN mysql perfschema agent items0 @@ -1497,23 +1497,32 @@ type QANMysqlSlowlogAgentItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Slowlog file is rotated at this size if > 0. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // query examples disabled QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Slowlog file is rotated at this size if > 0. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -1524,15 +1533,6 @@ type QANMysqlSlowlogAgentItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this QAN mysql slowlog agent items0 @@ -1630,18 +1630,27 @@ type QANPostgresqlPgstatementsAgentItems0 struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for getting pg stat statements data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -1651,15 +1660,6 @@ type QANPostgresqlPgstatementsAgentItems0 struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for getting pg stat statements data. - Username string `json:"username,omitempty"` } // Validate validates this QAN postgresql pgstatements agent items0 diff --git a/api/inventorypb/json/client/nodes/add_container_node_responses.go b/api/inventorypb/json/client/nodes/add_container_node_responses.go index 359f6a3524..5208d88f93 100644 --- a/api/inventorypb/json/client/nodes/add_container_node_responses.go +++ b/api/inventorypb/json/client/nodes/add_container_node_responses.go @@ -122,11 +122,14 @@ swagger:model AddContainerNodeBody */ type AddContainerNodeBody struct { + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` + // Linux machine-id of the Generic Node where this Container Node runs. + MachineID string `json:"machine_id,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -134,20 +137,17 @@ type AddContainerNodeBody struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux machine-id of the Generic Node where this Container Node runs. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add container node body @@ -275,11 +275,17 @@ swagger:model AddContainerNodeOKBodyContainer */ type AddContainerNodeOKBodyContainer struct { + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` + + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` + // Linux machine-id of the Generic Node where this Container Node runs. + MachineID string `json:"machine_id,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -287,23 +293,17 @@ type AddContainerNodeOKBodyContainer struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux machine-id of the Generic Node where this Container Node runs. - MachineID string `json:"machine_id,omitempty"` - - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add container node OK body container diff --git a/api/inventorypb/json/client/nodes/add_generic_node_responses.go b/api/inventorypb/json/client/nodes/add_generic_node_responses.go index c3ca0804f4..1d4b4b0567 100644 --- a/api/inventorypb/json/client/nodes/add_generic_node_responses.go +++ b/api/inventorypb/json/client/nodes/add_generic_node_responses.go @@ -122,29 +122,29 @@ swagger:model AddGenericNodeBody */ type AddGenericNodeBody struct { + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Linux machine-id. + MachineID string `json:"machine_id,omitempty"` // Linux distribution name and version. Distro string `json:"distro,omitempty"` - // Linux machine-id. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add generic node body @@ -272,32 +272,32 @@ swagger:model AddGenericNodeOKBodyGeneric */ type AddGenericNodeOKBodyGeneric struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` // Linux machine-id. MachineID string `json:"machine_id,omitempty"` - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add generic node OK body generic diff --git a/api/inventorypb/json/client/nodes/add_remote_node_responses.go b/api/inventorypb/json/client/nodes/add_remote_node_responses.go index 9997a17b58..532e2cebe3 100644 --- a/api/inventorypb/json/client/nodes/add_remote_node_responses.go +++ b/api/inventorypb/json/client/nodes/add_remote_node_responses.go @@ -122,23 +122,23 @@ swagger:model AddRemoteNodeBody */ type AddRemoteNodeBody struct { + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add remote node body @@ -266,26 +266,26 @@ swagger:model AddRemoteNodeOKBodyRemote */ type AddRemoteNodeOKBodyRemote struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Unique randomly generated instance identifier. NodeID string `json:"node_id,omitempty"` - // Node model. - NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` + + // Node model. + NodeModel string `json:"node_model,omitempty"` + // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add remote node OK body remote diff --git a/api/inventorypb/json/client/nodes/get_node_responses.go b/api/inventorypb/json/client/nodes/get_node_responses.go index 91605f8d60..a48dca97c2 100644 --- a/api/inventorypb/json/client/nodes/get_node_responses.go +++ b/api/inventorypb/json/client/nodes/get_node_responses.go @@ -301,11 +301,17 @@ swagger:model GetNodeOKBodyContainer */ type GetNodeOKBodyContainer struct { + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` + + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` + // Linux machine-id of the Generic Node where this Container Node runs. + MachineID string `json:"machine_id,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -313,23 +319,17 @@ type GetNodeOKBodyContainer struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux machine-id of the Generic Node where this Container Node runs. - MachineID string `json:"machine_id,omitempty"` - - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get node OK body container @@ -360,32 +360,32 @@ swagger:model GetNodeOKBodyGeneric */ type GetNodeOKBodyGeneric struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` // Linux machine-id. MachineID string `json:"machine_id,omitempty"` - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get node OK body generic @@ -416,26 +416,26 @@ swagger:model GetNodeOKBodyRemote */ type GetNodeOKBodyRemote struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Unique randomly generated instance identifier. NodeID string `json:"node_id,omitempty"` - // Node model. - NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` + + // Node model. + NodeModel string `json:"node_model,omitempty"` + // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get node OK body remote diff --git a/api/inventorypb/json/client/nodes/list_nodes_responses.go b/api/inventorypb/json/client/nodes/list_nodes_responses.go index 97ec2bedc1..39711210d4 100644 --- a/api/inventorypb/json/client/nodes/list_nodes_responses.go +++ b/api/inventorypb/json/client/nodes/list_nodes_responses.go @@ -123,11 +123,17 @@ swagger:model ContainerItems0 */ type ContainerItems0 struct { + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` + + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` + // Linux machine-id of the Generic Node where this Container Node runs. + MachineID string `json:"machine_id,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -135,23 +141,17 @@ type ContainerItems0 struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux machine-id of the Generic Node where this Container Node runs. - MachineID string `json:"machine_id,omitempty"` - - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this container items0 @@ -182,32 +182,32 @@ swagger:model GenericItems0 */ type GenericItems0 struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` // Linux machine-id. MachineID string `json:"machine_id,omitempty"` - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this generic items0 @@ -276,12 +276,12 @@ swagger:model ListNodesOKBody */ type ListNodesOKBody struct { - // container - Container []*ContainerItems0 `json:"container"` - // generic Generic []*GenericItems0 `json:"generic"` + // container + Container []*ContainerItems0 `json:"container"` + // remote Remote []*RemoteItems0 `json:"remote"` } @@ -290,11 +290,11 @@ type ListNodesOKBody struct { func (o *ListNodesOKBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateContainer(formats); err != nil { + if err := o.validateGeneric(formats); err != nil { res = append(res, err) } - if err := o.validateGeneric(formats); err != nil { + if err := o.validateContainer(formats); err != nil { res = append(res, err) } @@ -308,21 +308,21 @@ func (o *ListNodesOKBody) Validate(formats strfmt.Registry) error { return nil } -func (o *ListNodesOKBody) validateContainer(formats strfmt.Registry) error { +func (o *ListNodesOKBody) validateGeneric(formats strfmt.Registry) error { - if swag.IsZero(o.Container) { // not required + if swag.IsZero(o.Generic) { // not required return nil } - for i := 0; i < len(o.Container); i++ { - if swag.IsZero(o.Container[i]) { // not required + for i := 0; i < len(o.Generic); i++ { + if swag.IsZero(o.Generic[i]) { // not required continue } - if o.Container[i] != nil { - if err := o.Container[i].Validate(formats); err != nil { + if o.Generic[i] != nil { + if err := o.Generic[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listNodesOk" + "." + "container" + "." + strconv.Itoa(i)) + return ve.ValidateName("listNodesOk" + "." + "generic" + "." + strconv.Itoa(i)) } return err } @@ -333,21 +333,21 @@ func (o *ListNodesOKBody) validateContainer(formats strfmt.Registry) error { return nil } -func (o *ListNodesOKBody) validateGeneric(formats strfmt.Registry) error { +func (o *ListNodesOKBody) validateContainer(formats strfmt.Registry) error { - if swag.IsZero(o.Generic) { // not required + if swag.IsZero(o.Container) { // not required return nil } - for i := 0; i < len(o.Generic); i++ { - if swag.IsZero(o.Generic[i]) { // not required + for i := 0; i < len(o.Container); i++ { + if swag.IsZero(o.Container[i]) { // not required continue } - if o.Generic[i] != nil { - if err := o.Generic[i].Validate(formats); err != nil { + if o.Container[i] != nil { + if err := o.Container[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listNodesOk" + "." + "generic" + "." + strconv.Itoa(i)) + return ve.ValidateName("listNodesOk" + "." + "container" + "." + strconv.Itoa(i)) } return err } @@ -406,26 +406,26 @@ swagger:model RemoteItems0 */ type RemoteItems0 struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Unique randomly generated instance identifier. NodeID string `json:"node_id,omitempty"` - // Node model. - NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` + + // Node model. + NodeModel string `json:"node_model,omitempty"` + // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this remote items0 diff --git a/api/inventorypb/json/client/nodes/remove_node_responses.go b/api/inventorypb/json/client/nodes/remove_node_responses.go index d1ac9ca344..4f53b9c467 100644 --- a/api/inventorypb/json/client/nodes/remove_node_responses.go +++ b/api/inventorypb/json/client/nodes/remove_node_responses.go @@ -119,11 +119,11 @@ swagger:model RemoveNodeBody */ type RemoveNodeBody struct { - // Remove node with all dependencies. - Force bool `json:"force,omitempty"` - // Unique randomly generated instance identifier. NodeID string `json:"node_id,omitempty"` + + // Remove node with all dependencies. + Force bool `json:"force,omitempty"` } // Validate validates this remove node body diff --git a/api/inventorypb/json/client/services/add_mongo_db_service_responses.go b/api/inventorypb/json/client/services/add_mongo_db_service_responses.go index a6f4c3458d..7b98734ea6 100644 --- a/api/inventorypb/json/client/services/add_mongo_db_service_responses.go +++ b/api/inventorypb/json/client/services/add_mongo_db_service_responses.go @@ -122,29 +122,29 @@ swagger:model AddMongoDBServiceBody */ type AddMongoDBServiceBody struct { + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` + + // Node identifier where this instance runs. Required. + NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). Required. Address string `json:"address,omitempty"` - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Access port. Required. + Port int64 `json:"port,omitempty"` // Environment name. Environment string `json:"environment,omitempty"` - // Node identifier where this instance runs. Required. - NodeID string `json:"node_id,omitempty"` - - // Access port. Required. - Port int64 `json:"port,omitempty"` + // Cluster name. + Cluster string `json:"cluster,omitempty"` // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add mongo DB service body @@ -272,32 +272,32 @@ swagger:model AddMongoDBServiceOKBodyMongodb */ type AddMongoDBServiceOKBodyMongodb struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add mongo DB service OK body mongodb diff --git a/api/inventorypb/json/client/services/add_my_sql_service_responses.go b/api/inventorypb/json/client/services/add_my_sql_service_responses.go index 9f0a9b36db..806a6107ab 100644 --- a/api/inventorypb/json/client/services/add_my_sql_service_responses.go +++ b/api/inventorypb/json/client/services/add_my_sql_service_responses.go @@ -122,29 +122,29 @@ swagger:model AddMySQLServiceBody */ type AddMySQLServiceBody struct { + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` + + // Node identifier where this instance runs. Required. + NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). Required. Address string `json:"address,omitempty"` - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Access port. Required. + Port int64 `json:"port,omitempty"` // Environment name. Environment string `json:"environment,omitempty"` - // Node identifier where this instance runs. Required. - NodeID string `json:"node_id,omitempty"` - - // Access port. Required. - Port int64 `json:"port,omitempty"` + // Cluster name. + Cluster string `json:"cluster,omitempty"` // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add my SQL service body @@ -272,32 +272,32 @@ swagger:model AddMySQLServiceOKBodyMysql */ type AddMySQLServiceOKBodyMysql struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add my SQL service OK body mysql diff --git a/api/inventorypb/json/client/services/add_postgre_sql_service_responses.go b/api/inventorypb/json/client/services/add_postgre_sql_service_responses.go index 3f6507b612..05b4e183ce 100644 --- a/api/inventorypb/json/client/services/add_postgre_sql_service_responses.go +++ b/api/inventorypb/json/client/services/add_postgre_sql_service_responses.go @@ -122,29 +122,29 @@ swagger:model AddPostgreSQLServiceBody */ type AddPostgreSQLServiceBody struct { + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` + + // Node identifier where this instance runs. Required. + NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). Required. Address string `json:"address,omitempty"` - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Access port. Required. + Port int64 `json:"port,omitempty"` // Environment name. Environment string `json:"environment,omitempty"` - // Node identifier where this instance runs. Required. - NodeID string `json:"node_id,omitempty"` - - // Access port. Required. - Port int64 `json:"port,omitempty"` + // Cluster name. + Cluster string `json:"cluster,omitempty"` // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add postgre SQL service body @@ -272,32 +272,32 @@ swagger:model AddPostgreSQLServiceOKBodyPostgresql */ type AddPostgreSQLServiceOKBodyPostgresql struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add postgre SQL service OK body postgresql diff --git a/api/inventorypb/json/client/services/add_proxy_sql_service_responses.go b/api/inventorypb/json/client/services/add_proxy_sql_service_responses.go index e938975195..9d3357ae08 100644 --- a/api/inventorypb/json/client/services/add_proxy_sql_service_responses.go +++ b/api/inventorypb/json/client/services/add_proxy_sql_service_responses.go @@ -122,29 +122,29 @@ swagger:model AddProxySQLServiceBody */ type AddProxySQLServiceBody struct { + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` + + // Node identifier where this instance runs. Required. + NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). Required. Address string `json:"address,omitempty"` - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Access port. Required. + Port int64 `json:"port,omitempty"` // Environment name. Environment string `json:"environment,omitempty"` - // Node identifier where this instance runs. Required. - NodeID string `json:"node_id,omitempty"` - - // Access port. Required. - Port int64 `json:"port,omitempty"` + // Cluster name. + Cluster string `json:"cluster,omitempty"` // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add proxy SQL service body @@ -272,32 +272,32 @@ swagger:model AddProxySQLServiceOKBodyProxysql */ type AddProxySQLServiceOKBodyProxysql struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add proxy SQL service OK body proxysql diff --git a/api/inventorypb/json/client/services/get_service_responses.go b/api/inventorypb/json/client/services/get_service_responses.go index bbdbd1cd30..0d2ae285a2 100644 --- a/api/inventorypb/json/client/services/get_service_responses.go +++ b/api/inventorypb/json/client/services/get_service_responses.go @@ -326,32 +326,32 @@ swagger:model GetServiceOKBodyMongodb */ type GetServiceOKBodyMongodb struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get service OK body mongodb @@ -382,32 +382,32 @@ swagger:model GetServiceOKBodyMysql */ type GetServiceOKBodyMysql struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get service OK body mysql @@ -438,32 +438,32 @@ swagger:model GetServiceOKBodyPostgresql */ type GetServiceOKBodyPostgresql struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get service OK body postgresql @@ -494,32 +494,32 @@ swagger:model GetServiceOKBodyProxysql */ type GetServiceOKBodyProxysql struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this get service OK body proxysql diff --git a/api/inventorypb/json/client/services/list_services_responses.go b/api/inventorypb/json/client/services/list_services_responses.go index 900cceb198..2f5d589dcb 100644 --- a/api/inventorypb/json/client/services/list_services_responses.go +++ b/api/inventorypb/json/client/services/list_services_responses.go @@ -193,12 +193,12 @@ swagger:model ListServicesOKBody */ type ListServicesOKBody struct { - // mongodb - Mongodb []*MongodbItems0 `json:"mongodb"` - // mysql Mysql []*MysqlItems0 `json:"mysql"` + // mongodb + Mongodb []*MongodbItems0 `json:"mongodb"` + // postgresql Postgresql []*PostgresqlItems0 `json:"postgresql"` @@ -210,11 +210,11 @@ type ListServicesOKBody struct { func (o *ListServicesOKBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateMongodb(formats); err != nil { + if err := o.validateMysql(formats); err != nil { res = append(res, err) } - if err := o.validateMysql(formats); err != nil { + if err := o.validateMongodb(formats); err != nil { res = append(res, err) } @@ -232,21 +232,21 @@ func (o *ListServicesOKBody) Validate(formats strfmt.Registry) error { return nil } -func (o *ListServicesOKBody) validateMongodb(formats strfmt.Registry) error { +func (o *ListServicesOKBody) validateMysql(formats strfmt.Registry) error { - if swag.IsZero(o.Mongodb) { // not required + if swag.IsZero(o.Mysql) { // not required return nil } - for i := 0; i < len(o.Mongodb); i++ { - if swag.IsZero(o.Mongodb[i]) { // not required + for i := 0; i < len(o.Mysql); i++ { + if swag.IsZero(o.Mysql[i]) { // not required continue } - if o.Mongodb[i] != nil { - if err := o.Mongodb[i].Validate(formats); err != nil { + if o.Mysql[i] != nil { + if err := o.Mysql[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listServicesOk" + "." + "mongodb" + "." + strconv.Itoa(i)) + return ve.ValidateName("listServicesOk" + "." + "mysql" + "." + strconv.Itoa(i)) } return err } @@ -257,21 +257,21 @@ func (o *ListServicesOKBody) validateMongodb(formats strfmt.Registry) error { return nil } -func (o *ListServicesOKBody) validateMysql(formats strfmt.Registry) error { +func (o *ListServicesOKBody) validateMongodb(formats strfmt.Registry) error { - if swag.IsZero(o.Mysql) { // not required + if swag.IsZero(o.Mongodb) { // not required return nil } - for i := 0; i < len(o.Mysql); i++ { - if swag.IsZero(o.Mysql[i]) { // not required + for i := 0; i < len(o.Mongodb); i++ { + if swag.IsZero(o.Mongodb[i]) { // not required continue } - if o.Mysql[i] != nil { - if err := o.Mysql[i].Validate(formats); err != nil { + if o.Mongodb[i] != nil { + if err := o.Mongodb[i].Validate(formats); err != nil { if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("listServicesOk" + "." + "mysql" + "." + strconv.Itoa(i)) + return ve.ValidateName("listServicesOk" + "." + "mongodb" + "." + strconv.Itoa(i)) } return err } @@ -355,32 +355,32 @@ swagger:model MongodbItems0 */ type MongodbItems0 struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this mongodb items0 @@ -411,32 +411,32 @@ swagger:model MysqlItems0 */ type MysqlItems0 struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this mysql items0 @@ -467,32 +467,32 @@ swagger:model PostgresqlItems0 */ type PostgresqlItems0 struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this postgresql items0 @@ -523,32 +523,32 @@ swagger:model ProxysqlItems0 */ type ProxysqlItems0 struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this proxysql items0 diff --git a/api/inventorypb/json/client/services/remove_service_responses.go b/api/inventorypb/json/client/services/remove_service_responses.go index eba3dabe25..ef11a58b05 100644 --- a/api/inventorypb/json/client/services/remove_service_responses.go +++ b/api/inventorypb/json/client/services/remove_service_responses.go @@ -119,11 +119,11 @@ swagger:model RemoveServiceBody */ type RemoveServiceBody struct { - // Remove service with all dependencies. - Force bool `json:"force,omitempty"` - // Unique randomly generated instance identifier. Required. ServiceID string `json:"service_id,omitempty"` + + // Remove service with all dependencies. + Force bool `json:"force,omitempty"` } // Validate validates this remove service body diff --git a/api/inventorypb/json/inventorypb.json b/api/inventorypb/json/inventorypb.json index 4916d84708..95bcab97c2 100644 --- a/api/inventorypb/json/inventorypb.json +++ b/api/inventorypb/json/inventorypb.json @@ -35,38 +35,46 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "password": { "description": "MongoDB password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "MongoDB username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -84,32 +92,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -127,16 +141,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -185,38 +202,46 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "password": { "description": "MySQL password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -234,32 +259,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -277,16 +308,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -335,11 +369,13 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 1 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -357,28 +393,33 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 3 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -440,11 +481,13 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 1 }, "runs_on_node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -462,23 +505,27 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "connected": { "description": "True if Agent is running and connected to pmm-managed.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "runs_on_node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -527,38 +574,46 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "password": { "description": "PostgreSQL password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -576,32 +631,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -619,16 +680,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -677,38 +741,46 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "password": { "description": "ProxySQL password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -726,32 +798,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -769,16 +847,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -827,38 +908,46 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "password": { "description": "MongoDB password for getting profile data.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "MongoDB username for getting profile data.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -876,27 +965,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -914,16 +1008,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for getting profiler data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -972,43 +1069,52 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disable_query_examples": { "description": "Disable query examples.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "password": { "description": "MySQL password for getting performance data.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 8 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -1026,32 +1132,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "description": "True if query examples are disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1069,16 +1181,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -1127,48 +1242,58 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "disable_query_examples": { "description": "Disable query examples.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "max_slowlog_file_size": { "description": "Rotate slowlog file at this size if \u003e 0.\nUse zero or negative value to disable rotation.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 7 }, "password": { "description": "MySQL password for getting slowlog data.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 9 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "MySQL username for getting slowlog data.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -1186,36 +1311,43 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "max_slowlog_file_size": { "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 8 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1233,16 +1365,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -1291,38 +1426,46 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "password": { "description": "PostgreSQL password for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "username": { "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -1340,27 +1483,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1378,16 +1526,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -1432,7 +1583,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -1443,22 +1595,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -1478,32 +1634,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1521,16 +1683,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -1575,7 +1740,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -1586,22 +1752,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -1621,32 +1791,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1664,16 +1840,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -1718,7 +1897,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -1729,22 +1909,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -1764,28 +1948,33 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 3 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1843,7 +2032,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -1854,22 +2044,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -1889,32 +2083,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1932,16 +2132,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -1986,7 +2189,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -1997,22 +2201,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -2032,32 +2240,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2075,16 +2289,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -2129,7 +2346,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -2140,22 +2358,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -2175,27 +2397,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2213,16 +2440,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for getting profiler data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -2267,7 +2497,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -2278,22 +2509,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -2313,32 +2548,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "description": "True if query examples are disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2356,16 +2597,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -2410,7 +2654,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -2421,22 +2666,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -2456,36 +2705,43 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "max_slowlog_file_size": { "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 8 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2503,16 +2759,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -2557,7 +2816,8 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", @@ -2568,22 +2828,26 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable": { "description": "Enable this Agent. Can't be used with disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -2603,27 +2867,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2641,16 +2910,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -2696,7 +2968,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -2714,32 +2987,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2757,16 +3036,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -2776,32 +3058,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2819,16 +3107,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -2838,28 +3129,33 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 3 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2882,23 +3178,27 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "connected": { "description": "True if Agent is running and connected to pmm-managed.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "runs_on_node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 1 } } }, @@ -2908,32 +3208,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2951,16 +3257,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -2970,32 +3279,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3013,16 +3328,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -3032,27 +3350,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3070,16 +3393,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for getting profiler data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -3089,32 +3415,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "description": "True if query examples are disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3132,16 +3464,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -3151,36 +3486,43 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "max_slowlog_file_size": { "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 8 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3198,16 +3540,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -3217,27 +3562,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3255,16 +3605,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -3310,15 +3663,18 @@ "properties": { "node_id": { "description": "Return only Agents that provide insights for that Node.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", - "type": "string" + "type": "string", + "x-order": 1 }, "pmm_agent_id": { "description": "Return only Agents started by this pmm-agent.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Return only Agents that provide insights for that Service.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -3338,32 +3694,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3381,19 +3743,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 3 }, "mysqld_exporter": { "type": "array", @@ -3403,32 +3769,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3446,19 +3818,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 2 }, "node_exporter": { "type": "array", @@ -3468,28 +3844,33 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 3 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3505,7 +3886,8 @@ ] } } - } + }, + "x-order": 1 }, "pmm_agent": { "type": "array", @@ -3515,26 +3897,31 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "connected": { "description": "True if Agent is running and connected to pmm-managed.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "runs_on_node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 1 } } - } + }, + "x-order": 0 }, "postgres_exporter": { "type": "array", @@ -3544,32 +3931,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3587,19 +3980,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 4 }, "proxysql_exporter": { "type": "array", @@ -3609,32 +4006,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3652,19 +4055,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 5 }, "qan_mongodb_profiler_agent": { "type": "array", @@ -3674,27 +4081,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3712,19 +4124,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for getting profiler data.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 8 }, "qan_mysql_perfschema_agent": { "type": "array", @@ -3734,32 +4150,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "description": "True if query examples are disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3777,19 +4199,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 6 }, "qan_mysql_slowlog_agent": { "type": "array", @@ -3799,36 +4225,43 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "max_slowlog_file_size": { "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 8 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3846,19 +4279,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 7 }, "qan_postgresql_pgstatements_agent": { "type": "array", @@ -3868,27 +4305,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3906,19 +4348,23 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 9 } } } @@ -3961,12 +4407,14 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "force": { "description": "Remove agent with all dependencies.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 } } } @@ -4018,42 +4466,51 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 1 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 7 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 4 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "machine_id": { "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 0 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 } } } @@ -4071,46 +4528,56 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "machine_id": { "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } } @@ -4156,38 +4623,46 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 1 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 3 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 4 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 0 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 5 } } } @@ -4205,42 +4680,51 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 4 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 } } } @@ -4286,30 +4770,36 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 1 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 4 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 5 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 0 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 3 } } } @@ -4327,34 +4817,41 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -4400,7 +4897,8 @@ "properties": { "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -4418,46 +4916,56 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "machine_id": { "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } }, @@ -4467,42 +4975,51 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 4 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 } } }, @@ -4512,34 +5029,41 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -4599,49 +5123,60 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "machine_id": { "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } - } + }, + "x-order": 1 }, "generic": { "type": "array", @@ -4651,45 +5186,55 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 4 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 } } - } + }, + "x-order": 0 }, "remote": { "type": "array", @@ -4699,37 +5244,45 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 6 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 4 } } - } + }, + "x-order": 2 } } } @@ -4774,11 +5327,13 @@ "force": { "description": "Remove node with all dependencies.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -4830,39 +5385,47 @@ "properties": { "address": { "description": "Access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 4 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -4880,43 +5443,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -4962,39 +5534,47 @@ "properties": { "address": { "description": "Access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 4 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -5012,43 +5592,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -5094,39 +5683,47 @@ "properties": { "address": { "description": "Access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 4 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -5144,43 +5741,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -5226,39 +5832,47 @@ "properties": { "address": { "description": "Access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 4 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -5276,43 +5890,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -5358,7 +5981,8 @@ "properties": { "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -5376,43 +6000,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } }, @@ -5422,43 +6055,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } }, @@ -5468,43 +6110,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } }, @@ -5514,43 +6165,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -5596,7 +6256,8 @@ "properties": { "node_id": { "description": "Return only Services running on that Node.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -5616,46 +6277,56 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } - } + }, + "x-order": 1 }, "mysql": { "type": "array", @@ -5665,46 +6336,56 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } - } + }, + "x-order": 0 }, "postgresql": { "type": "array", @@ -5714,46 +6395,56 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } - } + }, + "x-order": 2 }, "proxysql": { "type": "array", @@ -5763,46 +6454,56 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } - } + }, + "x-order": 3 } } } @@ -5847,11 +6548,13 @@ "force": { "description": "Remove service with all dependencies.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "service_id": { "description": "Unique randomly generated instance identifier. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } diff --git a/api/managementpb/json/client/actions/get_action_responses.go b/api/managementpb/json/client/actions/get_action_responses.go index 887a5fd27b..73c27d9eb7 100644 --- a/api/managementpb/json/client/actions/get_action_responses.go +++ b/api/managementpb/json/client/actions/get_action_responses.go @@ -194,17 +194,17 @@ type GetActionOKBody struct { // Unique Action ID. ActionID string `json:"action_id,omitempty"` + // pmm-agent ID where this Action is running / was run. + PMMAgentID string `json:"pmm_agent_id,omitempty"` + + // Current Action output; may be partial if Action is still running. + Output string `json:"output,omitempty"` + // True if Action is finished. Done bool `json:"done,omitempty"` // Error message if Action failed. Error string `json:"error,omitempty"` - - // Current Action output; may be partial if Action is still running. - Output string `json:"output,omitempty"` - - // pmm-agent ID where this Action is running / was run. - PMMAgentID string `json:"pmm_agent_id,omitempty"` } // Validate validates this get action OK body diff --git a/api/managementpb/json/client/actions/start_my_sql_explain_action_responses.go b/api/managementpb/json/client/actions/start_my_sql_explain_action_responses.go index 7b36a01a08..264f47a1ef 100644 --- a/api/managementpb/json/client/actions/start_my_sql_explain_action_responses.go +++ b/api/managementpb/json/client/actions/start_my_sql_explain_action_responses.go @@ -121,17 +121,17 @@ swagger:model StartMySQLExplainActionBody */ type StartMySQLExplainActionBody struct { - // Database name. Required if it can't be deduced from the query. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service ID for this Action. Required. + ServiceID string `json:"service_id,omitempty"` + // SQL query. Required. Query string `json:"query,omitempty"` - // Service ID for this Action. Required. - ServiceID string `json:"service_id,omitempty"` + // Database name. Required if it can't be deduced from the query. + Database string `json:"database,omitempty"` } // Validate validates this start my SQL explain action body diff --git a/api/managementpb/json/client/actions/start_my_sql_explain_json_action_responses.go b/api/managementpb/json/client/actions/start_my_sql_explain_json_action_responses.go index 576a61c06c..ca31350d83 100644 --- a/api/managementpb/json/client/actions/start_my_sql_explain_json_action_responses.go +++ b/api/managementpb/json/client/actions/start_my_sql_explain_json_action_responses.go @@ -121,17 +121,17 @@ swagger:model StartMySQLExplainJSONActionBody */ type StartMySQLExplainJSONActionBody struct { - // Database name. Required if it can't be deduced from the query. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service ID for this Action. Required. + ServiceID string `json:"service_id,omitempty"` + // SQL query. Required. Query string `json:"query,omitempty"` - // Service ID for this Action. Required. - ServiceID string `json:"service_id,omitempty"` + // Database name. Required if it can't be deduced from the query. + Database string `json:"database,omitempty"` } // Validate validates this start my SQL explain JSON action body diff --git a/api/managementpb/json/client/actions/start_my_sql_explain_traditional_json_action_responses.go b/api/managementpb/json/client/actions/start_my_sql_explain_traditional_json_action_responses.go index 6059cf3713..b48ffd9e07 100644 --- a/api/managementpb/json/client/actions/start_my_sql_explain_traditional_json_action_responses.go +++ b/api/managementpb/json/client/actions/start_my_sql_explain_traditional_json_action_responses.go @@ -121,17 +121,17 @@ swagger:model StartMySQLExplainTraditionalJSONActionBody */ type StartMySQLExplainTraditionalJSONActionBody struct { - // Database name. Required if it can't be deduced from the query. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service ID for this Action. Required. + ServiceID string `json:"service_id,omitempty"` + // SQL query. Required. Query string `json:"query,omitempty"` - // Service ID for this Action. Required. - ServiceID string `json:"service_id,omitempty"` + // Database name. Required if it can't be deduced from the query. + Database string `json:"database,omitempty"` } // Validate validates this start my SQL explain traditional JSON action body diff --git a/api/managementpb/json/client/actions/start_my_sql_show_create_table_action_responses.go b/api/managementpb/json/client/actions/start_my_sql_show_create_table_action_responses.go index 0249f3f848..12b4bfcbb0 100644 --- a/api/managementpb/json/client/actions/start_my_sql_show_create_table_action_responses.go +++ b/api/managementpb/json/client/actions/start_my_sql_show_create_table_action_responses.go @@ -121,9 +121,6 @@ swagger:model StartMySQLShowCreateTableActionBody */ type StartMySQLShowCreateTableActionBody struct { - // Database name. Required if not given in the table_name field. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` @@ -132,6 +129,9 @@ type StartMySQLShowCreateTableActionBody struct { // Table name. Required. May additionally contain a database name. TableName string `json:"table_name,omitempty"` + + // Database name. Required if not given in the table_name field. + Database string `json:"database,omitempty"` } // Validate validates this start my SQL show create table action body diff --git a/api/managementpb/json/client/actions/start_my_sql_show_index_action_responses.go b/api/managementpb/json/client/actions/start_my_sql_show_index_action_responses.go index bcd8c9a992..66882a29cc 100644 --- a/api/managementpb/json/client/actions/start_my_sql_show_index_action_responses.go +++ b/api/managementpb/json/client/actions/start_my_sql_show_index_action_responses.go @@ -121,9 +121,6 @@ swagger:model StartMySQLShowIndexActionBody */ type StartMySQLShowIndexActionBody struct { - // Database name. Required if not given in the table_name field. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` @@ -132,6 +129,9 @@ type StartMySQLShowIndexActionBody struct { // Table name. Required. May additionally contain a database name. TableName string `json:"table_name,omitempty"` + + // Database name. Required if not given in the table_name field. + Database string `json:"database,omitempty"` } // Validate validates this start my SQL show index action body diff --git a/api/managementpb/json/client/actions/start_my_sql_show_table_status_action_responses.go b/api/managementpb/json/client/actions/start_my_sql_show_table_status_action_responses.go index 65263af016..c7b17207d0 100644 --- a/api/managementpb/json/client/actions/start_my_sql_show_table_status_action_responses.go +++ b/api/managementpb/json/client/actions/start_my_sql_show_table_status_action_responses.go @@ -121,9 +121,6 @@ swagger:model StartMySQLShowTableStatusActionBody */ type StartMySQLShowTableStatusActionBody struct { - // Database name. Required if not given in the table_name field. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` @@ -132,6 +129,9 @@ type StartMySQLShowTableStatusActionBody struct { // Table name. Required. May additionally contain a database name. TableName string `json:"table_name,omitempty"` + + // Database name. Required if not given in the table_name field. + Database string `json:"database,omitempty"` } // Validate validates this start my SQL show table status action body diff --git a/api/managementpb/json/client/actions/start_postgre_sql_show_create_table_action_responses.go b/api/managementpb/json/client/actions/start_postgre_sql_show_create_table_action_responses.go index 4dbab7da58..49412c1a96 100644 --- a/api/managementpb/json/client/actions/start_postgre_sql_show_create_table_action_responses.go +++ b/api/managementpb/json/client/actions/start_postgre_sql_show_create_table_action_responses.go @@ -121,9 +121,6 @@ swagger:model StartPostgreSQLShowCreateTableActionBody */ type StartPostgreSQLShowCreateTableActionBody struct { - // Database name. Required if not given in the table_name field. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` @@ -132,6 +129,9 @@ type StartPostgreSQLShowCreateTableActionBody struct { // Table name. Required. May additionally contain a database name. TableName string `json:"table_name,omitempty"` + + // Database name. Required if not given in the table_name field. + Database string `json:"database,omitempty"` } // Validate validates this start postgre SQL show create table action body diff --git a/api/managementpb/json/client/actions/start_postgre_sql_show_index_action_responses.go b/api/managementpb/json/client/actions/start_postgre_sql_show_index_action_responses.go index fd9ddd0473..76ef45ca6f 100644 --- a/api/managementpb/json/client/actions/start_postgre_sql_show_index_action_responses.go +++ b/api/managementpb/json/client/actions/start_postgre_sql_show_index_action_responses.go @@ -121,9 +121,6 @@ swagger:model StartPostgreSQLShowIndexActionBody */ type StartPostgreSQLShowIndexActionBody struct { - // Database name. Required if not given in the table_name field. - Database string `json:"database,omitempty"` - // pmm-agent ID where to run this Action. PMMAgentID string `json:"pmm_agent_id,omitempty"` @@ -132,6 +129,9 @@ type StartPostgreSQLShowIndexActionBody struct { // Table name. Required. May additionally contain a database name. TableName string `json:"table_name,omitempty"` + + // Database name. Required if not given in the table_name field. + Database string `json:"database,omitempty"` } // Validate validates this start postgre SQL show index action body diff --git a/api/managementpb/json/client/mongo_db/add_mongo_db_responses.go b/api/managementpb/json/client/mongo_db/add_mongo_db_responses.go index 0f419de339..08b1646b79 100644 --- a/api/managementpb/json/client/mongo_db/add_mongo_db_responses.go +++ b/api/managementpb/json/client/mongo_db/add_mongo_db_responses.go @@ -124,21 +124,6 @@ swagger:model AddMongoDBBody */ type AddMongoDBBody struct { - // add node - AddNode *AddMongoDBParamsBodyAddNode `json:"add_node,omitempty"` - - // Node and Service access address (DNS name or IP). Required. - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Environment name. - Environment string `json:"environment,omitempty"` - // Node identifier on which a service is been running. // Exactly one of these parameters should be present: node_id, node_name, add_node. NodeID string `json:"node_id,omitempty"` @@ -147,23 +132,38 @@ type AddMongoDBBody struct { // Exactly one of these parameters should be present: node_id, node_name, add_node. NodeName string `json:"node_name,omitempty"` - // MongoDB password for exporter and QAN agent access. - Password string `json:"password,omitempty"` + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` - // The "pmm-agent" identifier which should run agents. Required. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Node and Service access address (DNS name or IP). Required. + Address string `json:"address,omitempty"` // Service Access port. Required. Port int64 `json:"port,omitempty"` - // If true, adds qan-mongodb-profiler-agent for provided service. - QANMongodbProfiler bool `json:"qan_mongodb_profiler,omitempty"` + // The "pmm-agent" identifier which should run agents. Required. + PMMAgentID string `json:"pmm_agent_id,omitempty"` + + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // MongoDB username for exporter and QAN agent access. + Username string `json:"username,omitempty"` + + // MongoDB password for exporter and QAN agent access. + Password string `json:"password,omitempty"` + + // If true, adds qan-mongodb-profiler-agent for provided service. + QANMongodbProfiler bool `json:"qan_mongodb_profiler,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Skip connection check. SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` @@ -174,8 +174,8 @@ type AddMongoDBBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MongoDB username for exporter and QAN agent access. - Username string `json:"username,omitempty"` + // add node + AddNode *AddMongoDBParamsBodyAddNode `json:"add_node,omitempty"` } // Validate validates this add mongo DB body @@ -383,21 +383,30 @@ type AddMongoDBOKBodyMongodbExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -407,15 +416,6 @@ type AddMongoDBOKBodyMongodbExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add mongo DB OK body mongodb exporter @@ -513,18 +513,27 @@ type AddMongoDBOKBodyQANMongodbProfiler struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MongoDB username for getting profiler data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -534,15 +543,6 @@ type AddMongoDBOKBodyQANMongodbProfiler struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MongoDB username for getting profiler data. - Username string `json:"username,omitempty"` } // Validate validates this add mongo DB OK body QAN mongodb profiler @@ -637,32 +637,32 @@ swagger:model AddMongoDBOKBodyService */ type AddMongoDBOKBodyService struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add mongo DB OK body service @@ -693,8 +693,14 @@ swagger:model AddMongoDBParamsBodyAddNode */ type AddMongoDBParamsBodyAddNode struct { - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + + // Linux machine-id. + MachineID string `json:"machine_id,omitempty"` + + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -702,27 +708,21 @@ type AddMongoDBParamsBodyAddNode struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` - - // Linux machine-id. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` + // Node region. + Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // NodeType describes supported Node types. // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE] NodeType *string `json:"node_type,omitempty"` - - // Node region. - Region string `json:"region,omitempty"` } // Validate validates this add mongo DB params body add node diff --git a/api/managementpb/json/client/my_sql/add_my_sql_responses.go b/api/managementpb/json/client/my_sql/add_my_sql_responses.go index e62b7c986f..e2b5bcd638 100644 --- a/api/managementpb/json/client/my_sql/add_my_sql_responses.go +++ b/api/managementpb/json/client/my_sql/add_my_sql_responses.go @@ -124,68 +124,68 @@ swagger:model AddMySQLBody */ type AddMySQLBody struct { - // add node - AddNode *AddMySQLParamsBodyAddNode `json:"add_node,omitempty"` + // Node identifier on which a service is been running. + // Exactly one of these parameters should be present: node_id, node_name, add_node. + NodeID string `json:"node_id,omitempty"` + + // Node name on which a service is been running. + // Exactly one of these parameters should be present: node_id, node_name, add_node. + NodeName string `json:"node_name,omitempty"` + + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` // Node and Service access address (DNS name or IP). Required. Address string `json:"address,omitempty"` - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Service Access port. Required. + Port int64 `json:"port,omitempty"` - // Disable query examples. - DisableQueryExamples bool `json:"disable_query_examples,omitempty"` + // The "pmm-agent" identifier which should run agents. Required. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Environment name. Environment string `json:"environment,omitempty"` - // If qan-mysql-slowlog-agent is added, slowlog file is rotated at this size if > 0. - // If zero, default value 1GB is used. Use negative value to disable rotation. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Cluster name. + Cluster string `json:"cluster,omitempty"` - // Node identifier on which a service is been running. - // Exactly one of these parameters should be present: node_id, node_name, add_node. - NodeID string `json:"node_id,omitempty"` + // Replication set name. + ReplicationSet string `json:"replication_set,omitempty"` - // Node name on which a service is been running. - // Exactly one of these parameters should be present: node_id, node_name, add_node. - NodeName string `json:"node_name,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` // MySQL password for scraping metrics. Password string `json:"password,omitempty"` - // The "pmm-agent" identifier which should run agents. Required. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - - // Service Access port. Required. - Port int64 `json:"port,omitempty"` - // If true, adds qan-mysql-perfschema-agent for provided service. QANMysqlPerfschema bool `json:"qan_mysql_perfschema,omitempty"` // If true, adds qan-mysql-slowlog-agent for provided service. QANMysqlSlowlog bool `json:"qan_mysql_slowlog,omitempty"` - // Replication set name. - ReplicationSet string `json:"replication_set,omitempty"` - - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Skip connection check. SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` + // Disable query examples. + DisableQueryExamples bool `json:"disable_query_examples,omitempty"` + + // If qan-mysql-slowlog-agent is added, slowlog file is rotated at this size if > 0. + // If zero, default value 1GB is used. Use negative value to disable rotation. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Use TLS for database connections. TLS bool `json:"tls,omitempty"` // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` + // add node + AddNode *AddMySQLParamsBodyAddNode `json:"add_node,omitempty"` } // Validate validates this add my SQL body @@ -418,21 +418,30 @@ type AddMySQLOKBodyMysqldExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // MySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -442,15 +451,6 @@ type AddMySQLOKBodyMysqldExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add my SQL OK body mysqld exporter @@ -548,20 +548,29 @@ type AddMySQLOKBodyQANMysqlPerfschema struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` + + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // True if query examples are disabled. QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -572,15 +581,6 @@ type AddMySQLOKBodyQANMysqlPerfschema struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this add my SQL OK body QAN mysql perfschema @@ -678,23 +678,32 @@ type AddMySQLOKBodyQANMysqlSlowlog struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Slowlog file is rotated at this size if > 0. - MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + // Service identifier. + ServiceID string `json:"service_id,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // MySQL username for getting performance data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` // query examples disabled QueryExamplesDisabled bool `json:"query_examples_disabled,omitempty"` - // Service identifier. - ServiceID string `json:"service_id,omitempty"` + // Slowlog file is rotated at this size if > 0. + MaxSlowlogFileSize string `json:"max_slowlog_file_size,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // AgentStatus represents actual Agent status. // @@ -705,15 +714,6 @@ type AddMySQLOKBodyQANMysqlSlowlog struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // MySQL username for getting performance data. - Username string `json:"username,omitempty"` } // Validate validates this add my SQL OK body QAN mysql slowlog @@ -808,32 +808,32 @@ swagger:model AddMySQLOKBodyService */ type AddMySQLOKBodyService struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add my SQL OK body service @@ -864,8 +864,14 @@ swagger:model AddMySQLParamsBodyAddNode */ type AddMySQLParamsBodyAddNode struct { - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + + // Linux machine-id. + MachineID string `json:"machine_id,omitempty"` + + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -873,27 +879,21 @@ type AddMySQLParamsBodyAddNode struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` - - // Linux machine-id. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` + // Node region. + Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // NodeType describes supported Node types. // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE] NodeType *string `json:"node_type,omitempty"` - - // Node region. - Region string `json:"region,omitempty"` } // Validate validates this add my SQL params body add node diff --git a/api/managementpb/json/client/node/register_node_responses.go b/api/managementpb/json/client/node/register_node_responses.go index 4ea4487bca..c1fdc99500 100644 --- a/api/managementpb/json/client/node/register_node_responses.go +++ b/api/managementpb/json/client/node/register_node_responses.go @@ -124,11 +124,17 @@ swagger:model RegisterNodeBody */ type RegisterNodeBody struct { + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` + // Linux machine-id. + MachineID string `json:"machine_id,omitempty"` + + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -136,30 +142,24 @@ type RegisterNodeBody struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` - - // Linux machine-id. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - - // NodeType describes supported Node types. - // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE] - NodeType *string `json:"node_type,omitempty"` - // Node region. Region string `json:"region,omitempty"` + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // If true, and Node with that name already exist, it will be removed with all dependent Services and Agents. Reregister bool `json:"reregister,omitempty"` + + // NodeType describes supported Node types. + // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE] + NodeType *string `json:"node_type,omitempty"` } // Validate validates this register node body @@ -395,11 +395,17 @@ swagger:model RegisterNodeOKBodyContainerNode */ type RegisterNodeOKBodyContainerNode struct { + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` + + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + // Node address (DNS name or IP). Address string `json:"address,omitempty"` - // Node availability zone. - Az string `json:"az,omitempty"` + // Linux machine-id of the Generic Node where this Container Node runs. + MachineID string `json:"machine_id,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -407,23 +413,17 @@ type RegisterNodeOKBodyContainerNode struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux machine-id of the Generic Node where this Container Node runs. - MachineID string `json:"machine_id,omitempty"` - - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this register node OK body container node @@ -454,32 +454,32 @@ swagger:model RegisterNodeOKBodyGenericNode */ type RegisterNodeOKBodyGenericNode struct { - // Node address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique randomly generated instance identifier. + NodeID string `json:"node_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` + // Node address (DNS name or IP). + Address string `json:"address,omitempty"` // Linux machine-id. MachineID string `json:"machine_id,omitempty"` - // Unique randomly generated instance identifier. - NodeID string `json:"node_id,omitempty"` + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` - // Node region. Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this register node OK body generic node @@ -513,14 +513,14 @@ type RegisterNodeOKBodyPMMAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // True if Agent is running and connected to pmm-managed. - Connected bool `json:"connected,omitempty"` + // Node identifier where this instance runs. + RunsOnNodeID string `json:"runs_on_node_id,omitempty"` // Custom user-assigned labels. CustomLabels map[string]string `json:"custom_labels,omitempty"` - // Node identifier where this instance runs. - RunsOnNodeID string `json:"runs_on_node_id,omitempty"` + // True if Agent is running and connected to pmm-managed. + Connected bool `json:"connected,omitempty"` } // Validate validates this register node OK body PMM agent diff --git a/api/managementpb/json/client/postgre_sql/add_postgre_sql_responses.go b/api/managementpb/json/client/postgre_sql/add_postgre_sql_responses.go index 32ee6c5ec6..52b56844d1 100644 --- a/api/managementpb/json/client/postgre_sql/add_postgre_sql_responses.go +++ b/api/managementpb/json/client/postgre_sql/add_postgre_sql_responses.go @@ -124,21 +124,6 @@ swagger:model AddPostgreSQLBody */ type AddPostgreSQLBody struct { - // add node - AddNode *AddPostgreSQLParamsBodyAddNode `json:"add_node,omitempty"` - - // Node and Service access address (DNS name or IP). Required. - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Environment name. - Environment string `json:"environment,omitempty"` - // Node identifier on which a service is been running. // Exactly one of these parameters should be present: node_id, node_name, add_node. NodeID string `json:"node_id,omitempty"` @@ -147,23 +132,38 @@ type AddPostgreSQLBody struct { // Exactly one of these parameters should be present: node_id, node_name, add_node. NodeName string `json:"node_name,omitempty"` - // PostgreSQL password for scraping metrics. - Password string `json:"password,omitempty"` + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` - // The "pmm-agent" identifier which should run agents. Required. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Node and Service access address (DNS name or IP). Required. + Address string `json:"address,omitempty"` // Service Access port. Required. Port int64 `json:"port,omitempty"` - // If true, adds qan-postgresql-pgstatements-agent for provided service. - QANPostgresqlPgstatementsAgent bool `json:"qan_postgresql_pgstatements_agent,omitempty"` + // The "pmm-agent" identifier which should run agents. Required. + PMMAgentID string `json:"pmm_agent_id,omitempty"` + + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // PostgreSQL password for scraping metrics. + Password string `json:"password,omitempty"` + + // If true, adds qan-postgresql-pgstatements-agent for provided service. + QANPostgresqlPgstatementsAgent bool `json:"qan_postgresql_pgstatements_agent,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Skip connection check. SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` @@ -174,8 +174,8 @@ type AddPostgreSQLBody struct { // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` + // add node + AddNode *AddPostgreSQLParamsBodyAddNode `json:"add_node,omitempty"` } // Validate validates this add postgre SQL body @@ -383,21 +383,30 @@ type AddPostgreSQLOKBodyPostgresExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -407,15 +416,6 @@ type AddPostgreSQLOKBodyPostgresExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add postgre SQL OK body postgres exporter @@ -513,18 +513,27 @@ type AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // PostgreSQL username for getting pg stat statements data. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -534,15 +543,6 @@ type AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // PostgreSQL username for getting pg stat statements data. - Username string `json:"username,omitempty"` } // Validate validates this add postgre SQL OK body QAN postgresql pgstatements agent @@ -637,32 +637,32 @@ swagger:model AddPostgreSQLOKBodyService */ type AddPostgreSQLOKBodyService struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add postgre SQL OK body service @@ -693,8 +693,14 @@ swagger:model AddPostgreSQLParamsBodyAddNode */ type AddPostgreSQLParamsBodyAddNode struct { - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + + // Linux machine-id. + MachineID string `json:"machine_id,omitempty"` + + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -702,27 +708,21 @@ type AddPostgreSQLParamsBodyAddNode struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` - - // Linux machine-id. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` + // Node region. + Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // NodeType describes supported Node types. // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE] NodeType *string `json:"node_type,omitempty"` - - // Node region. - Region string `json:"region,omitempty"` } // Validate validates this add postgre SQL params body add node diff --git a/api/managementpb/json/client/proxy_sql/add_proxy_sql_responses.go b/api/managementpb/json/client/proxy_sql/add_proxy_sql_responses.go index 8601616991..cb9d2e0edc 100644 --- a/api/managementpb/json/client/proxy_sql/add_proxy_sql_responses.go +++ b/api/managementpb/json/client/proxy_sql/add_proxy_sql_responses.go @@ -124,21 +124,6 @@ swagger:model AddProxySQLBody */ type AddProxySQLBody struct { - // add node - AddNode *AddProxySQLParamsBodyAddNode `json:"add_node,omitempty"` - - // Node and Service access address (DNS name or IP). Required. - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // custom labels - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Environment name. - Environment string `json:"environment,omitempty"` - // Node identifier on which a service is been running. // Exactly one of these parameters should be present: node_id, node_name, add_node. NodeID string `json:"node_id,omitempty"` @@ -147,20 +132,35 @@ type AddProxySQLBody struct { // Exactly one of these parameters should be present: node_id, node_name, add_node. NodeName string `json:"node_name,omitempty"` - // ProxySQL password for scraping metrics. - Password string `json:"password,omitempty"` + // Unique across all Services user-defined name. Required. + ServiceName string `json:"service_name,omitempty"` - // The "pmm-agent" identifier which should run agents. Required. - PMMAgentID string `json:"pmm_agent_id,omitempty"` + // Node and Service access address (DNS name or IP). Required. + Address string `json:"address,omitempty"` // Service Access port. Required. Port int64 `json:"port,omitempty"` + // The "pmm-agent" identifier which should run agents. Required. + PMMAgentID string `json:"pmm_agent_id,omitempty"` + + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique across all Services user-defined name. Required. - ServiceName string `json:"service_name,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // ProxySQL password for scraping metrics. + Password string `json:"password,omitempty"` + + // custom labels + CustomLabels map[string]string `json:"custom_labels,omitempty"` // Skip connection check. SkipConnectionCheck bool `json:"skip_connection_check,omitempty"` @@ -171,8 +171,8 @@ type AddProxySQLBody struct { // Skip TLS certificate and hostname validation. TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` + // add node + AddNode *AddProxySQLParamsBodyAddNode `json:"add_node,omitempty"` } // Validate validates this add proxy SQL body @@ -355,21 +355,30 @@ type AddProxySQLOKBodyProxysqlExporter struct { // Unique randomly generated instance identifier. AgentID string `json:"agent_id,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // The pmm-agent identifier which runs this instance. + PMMAgentID string `json:"pmm_agent_id,omitempty"` // Desired Agent status: enabled (false) or disabled (true). Disabled bool `json:"disabled,omitempty"` - // Listen port for scraping metrics. - ListenPort int64 `json:"listen_port,omitempty"` - - // The pmm-agent identifier which runs this instance. - PMMAgentID string `json:"pmm_agent_id,omitempty"` - // Service identifier. ServiceID string `json:"service_id,omitempty"` + // ProxySQL username for scraping metrics. + Username string `json:"username,omitempty"` + + // Use TLS for database connections. + TLS bool `json:"tls,omitempty"` + + // Skip TLS certificate and hostname validation. + TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` + + // Listen port for scraping metrics. + ListenPort int64 `json:"listen_port,omitempty"` + // AgentStatus represents actual Agent status. // // - STARTING: Agent is starting. @@ -379,15 +388,6 @@ type AddProxySQLOKBodyProxysqlExporter struct { // - DONE: Agent finished. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` - - // Use TLS for database connections. - TLS bool `json:"tls,omitempty"` - - // Skip TLS certificate and hostname validation. - TLSSkipVerify bool `json:"tls_skip_verify,omitempty"` - - // ProxySQL username for scraping metrics. - Username string `json:"username,omitempty"` } // Validate validates this add proxy SQL OK body proxysql exporter @@ -482,32 +482,32 @@ swagger:model AddProxySQLOKBodyService */ type AddProxySQLOKBodyService struct { - // Access address (DNS name or IP). - Address string `json:"address,omitempty"` - - // Cluster name. - Cluster string `json:"cluster,omitempty"` - - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` + // Unique randomly generated instance identifier. + ServiceID string `json:"service_id,omitempty"` - // Environment name. - Environment string `json:"environment,omitempty"` + // Unique across all Services user-defined name. + ServiceName string `json:"service_name,omitempty"` // Node identifier where this instance runs. NodeID string `json:"node_id,omitempty"` + // Access address (DNS name or IP). + Address string `json:"address,omitempty"` + // Access port. Port int64 `json:"port,omitempty"` + // Environment name. + Environment string `json:"environment,omitempty"` + + // Cluster name. + Cluster string `json:"cluster,omitempty"` + // Replication set name. ReplicationSet string `json:"replication_set,omitempty"` - // Unique randomly generated instance identifier. - ServiceID string `json:"service_id,omitempty"` - - // Unique across all Services user-defined name. - ServiceName string `json:"service_name,omitempty"` + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` } // Validate validates this add proxy SQL OK body service @@ -538,8 +538,14 @@ swagger:model AddProxySQLParamsBodyAddNode */ type AddProxySQLParamsBodyAddNode struct { - // Node availability zone. - Az string `json:"az,omitempty"` + // Unique across all Nodes user-defined name. + NodeName string `json:"node_name,omitempty"` + + // Linux machine-id. + MachineID string `json:"machine_id,omitempty"` + + // Linux distribution name and version. + Distro string `json:"distro,omitempty"` // Container identifier. If specified, must be a unique Docker container identifier. ContainerID string `json:"container_id,omitempty"` @@ -547,27 +553,21 @@ type AddProxySQLParamsBodyAddNode struct { // Container name. ContainerName string `json:"container_name,omitempty"` - // Custom user-assigned labels. - CustomLabels map[string]string `json:"custom_labels,omitempty"` - - // Linux distribution name and version. - Distro string `json:"distro,omitempty"` - - // Linux machine-id. - MachineID string `json:"machine_id,omitempty"` - // Node model. NodeModel string `json:"node_model,omitempty"` - // Unique across all Nodes user-defined name. - NodeName string `json:"node_name,omitempty"` + // Node region. + Region string `json:"region,omitempty"` + + // Node availability zone. + Az string `json:"az,omitempty"` + + // Custom user-assigned labels. + CustomLabels map[string]string `json:"custom_labels,omitempty"` // NodeType describes supported Node types. // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE] NodeType *string `json:"node_type,omitempty"` - - // Node region. - Region string `json:"region,omitempty"` } // Validate validates this add proxy SQL params body add node diff --git a/api/managementpb/json/managementpb.json b/api/managementpb/json/managementpb.json index e915731c68..b00042044c 100644 --- a/api/managementpb/json/managementpb.json +++ b/api/managementpb/json/managementpb.json @@ -32,7 +32,8 @@ "properties": { "action_id": { "description": "Unique Action ID. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -84,7 +85,8 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -98,24 +100,29 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "done": { "description": "True if Action is finished.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 }, "error": { "description": "Error message if Action failed.", - "type": "string" + "type": "string", + "x-order": 4 }, "output": { "description": "Current Action output; may be partial if Action is still running.", - "type": "string" + "type": "string", + "x-order": 2 }, "pmm_agent_id": { "description": "pmm-agent ID where this Action is running / was run.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -159,19 +166,23 @@ "properties": { "database": { "description": "Database name. Required if it can't be deduced from the query.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "query": { "description": "SQL query. Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -185,11 +196,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -233,19 +246,23 @@ "properties": { "database": { "description": "Database name. Required if it can't be deduced from the query.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "query": { "description": "SQL query. Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -259,11 +276,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -307,19 +326,23 @@ "properties": { "database": { "description": "Database name. Required if it can't be deduced from the query.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "query": { "description": "SQL query. Required.", - "type": "string" + "type": "string", + "x-order": 2 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -333,11 +356,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -381,19 +406,23 @@ "properties": { "database": { "description": "Database name. Required if not given in the table_name field.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -407,11 +436,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -455,19 +486,23 @@ "properties": { "database": { "description": "Database name. Required if not given in the table_name field.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -481,11 +516,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -529,19 +566,23 @@ "properties": { "database": { "description": "Database name. Required if not given in the table_name field.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -555,11 +596,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -603,19 +646,23 @@ "properties": { "database": { "description": "Database name. Required if not given in the table_name field.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -629,11 +676,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -677,19 +726,23 @@ "properties": { "database": { "description": "Database name. Required if not given in the table_name field.", - "type": "string" + "type": "string", + "x-order": 3 }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -703,11 +756,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -755,38 +810,46 @@ "properties": { "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 3 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "node_type": { "description": "NodeType describes supported Node types.", @@ -801,81 +864,98 @@ }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 4 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 8 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 13 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, "node_id": { "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_name": { "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 1 }, "password": { "description": "MongoDB password for exporter and QAN agent access.", - "type": "string" + "type": "string", + "x-order": 11 }, "pmm_agent_id": { "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" + "type": "string", + "x-order": 6 }, "port": { "description": "Service Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "qan_mongodb_profiler": { "description": "If true, adds qan-mongodb-profiler-agent for provided service.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 12 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 9 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 3 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 14 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 16 }, "username": { "description": "MongoDB username for exporter and QAN agent access.", - "type": "string" + "type": "string", + "x-order": 10 } } } @@ -893,32 +973,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -936,16 +1022,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -955,27 +1044,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -993,16 +1087,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MongoDB username for getting profiler data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -1012,43 +1109,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -1098,38 +1204,46 @@ "properties": { "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 3 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "node_type": { "description": "NodeType describes supported Node types.", @@ -1144,96 +1258,116 @@ }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 4 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 8 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 14 }, "disable_query_examples": { "description": "Disable query examples.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 16 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, "max_slowlog_file_size": { "description": "If qan-mysql-slowlog-agent is added, slowlog file is rotated at this size if \u003e 0.\nIf zero, default value 1GB is used. Use negative value to disable rotation.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 17 }, "node_id": { "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_name": { "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 1 }, "password": { "description": "MySQL password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 11 }, "pmm_agent_id": { "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" + "type": "string", + "x-order": 6 }, "port": { "description": "Service Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "qan_mysql_perfschema": { "description": "If true, adds qan-mysql-perfschema-agent for provided service.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 12 }, "qan_mysql_slowlog": { "description": "If true, adds qan-mysql-slowlog-agent for provided service.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 13 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 9 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 3 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 18 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 19 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 10 } } } @@ -1251,32 +1385,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1294,16 +1434,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -1313,32 +1456,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "description": "True if query examples are disabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1356,16 +1505,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -1375,36 +1527,43 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "max_slowlog_file_size": { "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" + "format": "int64", + "x-order": 8 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "query_examples_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 7 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1422,16 +1581,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "MySQL username for getting performance data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -1441,43 +1603,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -1523,42 +1694,51 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 9 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 5 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 10 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 4 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 7 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "node_type": { "description": "NodeType describes supported Node types.", @@ -1573,12 +1753,14 @@ }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 8 }, "reregister": { "description": "If true, and Node with that name already exist, it will be removed with all dependent Services and Agents.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 11 } } } @@ -1596,46 +1778,56 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "machine_id": { "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } }, @@ -1645,42 +1837,51 @@ "properties": { "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 4 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 } } }, @@ -1690,23 +1891,27 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "connected": { "description": "True if Agent is running and connected to pmm-managed.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, "runs_on_node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -1756,38 +1961,46 @@ "properties": { "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 3 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "node_type": { "description": "NodeType describes supported Node types.", @@ -1802,81 +2015,98 @@ }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 4 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 8 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 13 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, "node_id": { "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_name": { "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 1 }, "password": { "description": "PostgreSQL password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 11 }, "pmm_agent_id": { "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" + "type": "string", + "x-order": 6 }, "port": { "description": "Service Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "qan_postgresql_pgstatements_agent": { "description": "If true, adds qan-postgresql-pgstatements-agent for provided service.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 12 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 9 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 3 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 14 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 16 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 10 } } } @@ -1894,32 +2124,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1937,16 +2173,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -1956,27 +2195,32 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1994,16 +2238,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -2013,43 +2260,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -2099,38 +2355,46 @@ "properties": { "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 3 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 2 }, "node_model": { "description": "Node model.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_name": { "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 }, "node_type": { "description": "NodeType describes supported Node types.", @@ -2145,75 +2409,91 @@ }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 } } }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 4 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 8 }, "custom_labels": { "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 12 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, "node_id": { "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_name": { "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 1 }, "password": { "description": "ProxySQL password for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 11 }, "pmm_agent_id": { "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" + "type": "string", + "x-order": 6 }, "port": { "description": "Service Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 9 }, "service_name": { "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "type": "string", + "x-order": 3 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 13 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 14 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 10 } } } @@ -2231,32 +2511,38 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, "disabled": { "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 9 }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2274,16 +2560,19 @@ "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "username": { "description": "ProxySQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 } } }, @@ -2293,43 +2582,52 @@ "properties": { "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -2375,11 +2673,13 @@ "properties": { "service_id": { "description": "Service ID or Service Name is required.\nUnique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, "service_name": { "description": "Unique across all Services user-defined name.", - "type": "string" + "type": "string", + "x-order": 2 }, "service_type": { "description": "ServiceType describes supported Service types.", diff --git a/api/qanpb/json/client/filters/get_responses.go b/api/qanpb/json/client/filters/get_responses.go index dac339b0ef..ae6d1c09f7 100644 --- a/api/qanpb/json/client/filters/get_responses.go +++ b/api/qanpb/json/client/filters/get_responses.go @@ -76,9 +76,6 @@ swagger:model GetBody */ type GetBody struct { - // main metric name - MainMetricName string `json:"main_metric_name,omitempty"` - // period start from // Format: date-time PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` @@ -86,6 +83,9 @@ type GetBody struct { // period start to // Format: date-time PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` + + // main metric name + MainMetricName string `json:"main_metric_name,omitempty"` } // Validate validates this get body @@ -285,14 +285,14 @@ swagger:model LabelsAnonNameItems0 */ type LabelsAnonNameItems0 struct { - // main metric per sec - MainMetricPerSec float32 `json:"main_metric_per_sec,omitempty"` + // value + Value string `json:"value,omitempty"` // main metric percent MainMetricPercent float32 `json:"main_metric_percent,omitempty"` - // value - Value string `json:"value,omitempty"` + // main metric per sec + MainMetricPerSec float32 `json:"main_metric_per_sec,omitempty"` } // Validate validates this labels anon name items0 diff --git a/api/qanpb/json/client/object_details/get_labels_responses.go b/api/qanpb/json/client/object_details/get_labels_responses.go index a446dc263d..2d580349a4 100644 --- a/api/qanpb/json/client/object_details/get_labels_responses.go +++ b/api/qanpb/json/client/object_details/get_labels_responses.go @@ -124,12 +124,6 @@ swagger:model GetLabelsBody */ type GetLabelsBody struct { - // dimension value: ex: queryid - 1D410B4BE5060972. - FilterBy string `json:"filter_by,omitempty"` - - // one of dimension: queryid | host ... - GroupBy string `json:"group_by,omitempty"` - // period start from // Format: date-time PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` @@ -137,6 +131,12 @@ type GetLabelsBody struct { // period start to // Format: date-time PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` + + // dimension value: ex: queryid - 1D410B4BE5060972. + FilterBy string `json:"filter_by,omitempty"` + + // one of dimension: queryid | host ... + GroupBy string `json:"group_by,omitempty"` } // Validate validates this get labels body diff --git a/api/qanpb/json/client/object_details/get_metrics_responses.go b/api/qanpb/json/client/object_details/get_metrics_responses.go index d6d99fa318..88a43de059 100644 --- a/api/qanpb/json/client/object_details/get_metrics_responses.go +++ b/api/qanpb/json/client/object_details/get_metrics_responses.go @@ -124,40 +124,40 @@ swagger:model GetMetricsBody */ type GetMetricsBody struct { + // period start from + // Format: date-time + PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` + + // period start to + // Format: date-time + PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` + // dimension value: ex: queryid - 1D410B4BE5060972. FilterBy string `json:"filter_by,omitempty"` // one of dimension: queryid | host ... GroupBy string `json:"group_by,omitempty"` - // include only fields - IncludeOnlyFields []string `json:"include_only_fields"` - // labels Labels []*LabelsItems0 `json:"labels"` - // period start from - // Format: date-time - PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` - - // period start to - // Format: date-time - PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` + // include only fields + IncludeOnlyFields []string `json:"include_only_fields"` } // Validate validates this get metrics body func (o *GetMetricsBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateLabels(formats); err != nil { + if err := o.validatePeriodStartFrom(formats); err != nil { res = append(res, err) } - if err := o.validatePeriodStartFrom(formats); err != nil { + if err := o.validatePeriodStartTo(formats); err != nil { res = append(res, err) } - if err := o.validatePeriodStartTo(formats); err != nil { + if err := o.validateLabels(formats); err != nil { res = append(res, err) } @@ -167,52 +167,52 @@ func (o *GetMetricsBody) Validate(formats strfmt.Registry) error { return nil } -func (o *GetMetricsBody) validateLabels(formats strfmt.Registry) error { +func (o *GetMetricsBody) validatePeriodStartFrom(formats strfmt.Registry) error { - if swag.IsZero(o.Labels) { // not required + if swag.IsZero(o.PeriodStartFrom) { // not required return nil } - for i := 0; i < len(o.Labels); i++ { - if swag.IsZero(o.Labels[i]) { // not required - continue - } - - if o.Labels[i] != nil { - if err := o.Labels[i].Validate(formats); err != nil { - if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("body" + "." + "labels" + "." + strconv.Itoa(i)) - } - return err - } - } - + if err := validate.FormatOf("body"+"."+"period_start_from", "body", "date-time", o.PeriodStartFrom.String(), formats); err != nil { + return err } return nil } -func (o *GetMetricsBody) validatePeriodStartFrom(formats strfmt.Registry) error { +func (o *GetMetricsBody) validatePeriodStartTo(formats strfmt.Registry) error { - if swag.IsZero(o.PeriodStartFrom) { // not required + if swag.IsZero(o.PeriodStartTo) { // not required return nil } - if err := validate.FormatOf("body"+"."+"period_start_from", "body", "date-time", o.PeriodStartFrom.String(), formats); err != nil { + if err := validate.FormatOf("body"+"."+"period_start_to", "body", "date-time", o.PeriodStartTo.String(), formats); err != nil { return err } return nil } -func (o *GetMetricsBody) validatePeriodStartTo(formats strfmt.Registry) error { +func (o *GetMetricsBody) validateLabels(formats strfmt.Registry) error { - if swag.IsZero(o.PeriodStartTo) { // not required + if swag.IsZero(o.Labels) { // not required return nil } - if err := validate.FormatOf("body"+"."+"period_start_to", "body", "date-time", o.PeriodStartTo.String(), formats); err != nil { - return err + for i := 0; i < len(o.Labels); i++ { + if swag.IsZero(o.Labels[i]) { // not required + continue + } + + if o.Labels[i] != nil { + if err := o.Labels[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("body" + "." + "labels" + "." + strconv.Itoa(i)) + } + return err + } + } + } return nil @@ -438,29 +438,29 @@ swagger:model MetricsAnon */ type MetricsAnon struct { - // avg - Avg float32 `json:"avg,omitempty"` + // rate + Rate float32 `json:"rate,omitempty"` // cnt Cnt float32 `json:"cnt,omitempty"` - // max - Max float32 `json:"max,omitempty"` + // sum + Sum float32 `json:"sum,omitempty"` // min Min float32 `json:"min,omitempty"` + // max + Max float32 `json:"max,omitempty"` + + // avg + Avg float32 `json:"avg,omitempty"` + // p99 P99 float32 `json:"p99,omitempty"` // percent of total PercentOfTotal float32 `json:"percent_of_total,omitempty"` - - // rate - Rate float32 `json:"rate,omitempty"` - - // sum - Sum float32 `json:"sum,omitempty"` } // Validate validates this metrics anon @@ -492,79 +492,80 @@ swagger:model SparklineItems0 */ type SparklineItems0 struct { + // The serial number of the chart point from the largest time in the time interval to the lowest time in the time range. + Point int64 `json:"point,omitempty"` + + // Duration beetween two points. + TimeFrame int64 `json:"time_frame,omitempty"` + + // Time of point in format RFC3339. + Timestamp string `json:"timestamp,omitempty"` + // load is query_time / time_range. Load float32 `json:"load,omitempty"` - // Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). - MBlkReadTimeSumPerSec float32 `json:"m_blk_read_time_sum_per_sec,omitempty"` + // number of queries in bucket. + NumQueriesPerSec float32 `json:"num_queries_per_sec,omitempty"` - // Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). - MBlkWriteTimeSumPerSec float32 `json:"m_blk_write_time_sum_per_sec,omitempty"` + // number of queries with errors. + NumQueriesWithErrorsPerSec float32 `json:"num_queries_with_errors_per_sec,omitempty"` - // The number of bytes sent to all clients. - MBytesSentSumPerSec float32 `json:"m_bytes_sent_sum_per_sec,omitempty"` + // number of queries with warnings. + NumQueriesWithWarningsPerSec float32 `json:"num_queries_with_warnings_per_sec,omitempty"` - // MongoDB metrics. - // - // The number of returned documents. - MDocsReturnedSumPerSec float32 `json:"m_docs_returned_sum_per_sec,omitempty"` + // The statement execution time in seconds. + MQueryTimeSumPerSec float32 `json:"m_query_time_sum_per_sec,omitempty"` - // The number of scanned documents. - MDocsScannedSumPerSec float32 `json:"m_docs_scanned_sum_per_sec,omitempty"` + // The time to acquire locks in seconds. + MLockTimeSumPerSec float32 `json:"m_lock_time_sum_per_sec,omitempty"` - // The filesort was performed on disk. - MFilesortOnDiskSumPerSec float32 `json:"m_filesort_on_disk_sum_per_sec,omitempty"` + // The number of rows sent to the client. + MRowsSentSumPerSec float32 `json:"m_rows_sent_sum_per_sec,omitempty"` - // The query used a filesort. - MFilesortSumPerSec float32 `json:"m_filesort_sum_per_sec,omitempty"` + // Number of rows scanned - SELECT. + MRowsExaminedSumPerSec float32 `json:"m_rows_examined_sum_per_sec,omitempty"` - // The query performed a full join (a join without indexes). - MFullJoinSumPerSec float32 `json:"m_full_join_sum_per_sec,omitempty"` + // Number of rows changed - UPDATE, DELETE, INSERT. + MRowsAffectedSumPerSec float32 `json:"m_rows_affected_sum_per_sec,omitempty"` - // The query performed a full table scan. - MFullScanSumPerSec float32 `json:"m_full_scan_sum_per_sec,omitempty"` + // The number of rows read from tables. + MRowsReadSumPerSec float32 `json:"m_rows_read_sum_per_sec,omitempty"` - // Similar to innodb_IO_r_ops, but the unit is bytes. - MInnodbIorBytesSumPerSec float32 `json:"m_innodb_io_r_bytes_sum_per_sec,omitempty"` + // The number of merge passes that the sort algorithm has had to do. + MMergePassesSumPerSec float32 `json:"m_merge_passes_sum_per_sec,omitempty"` // Counts the number of page read operations scheduled. MInnodbIorOpsSumPerSec float32 `json:"m_innodb_io_r_ops_sum_per_sec,omitempty"` + // Similar to innodb_IO_r_ops, but the unit is bytes. + MInnodbIorBytesSumPerSec float32 `json:"m_innodb_io_r_bytes_sum_per_sec,omitempty"` + // Shows how long (in seconds) it took InnoDB to actually read the data from storage. MInnodbIorWaitSumPerSec float32 `json:"m_innodb_io_r_wait_sum_per_sec,omitempty"` - // Counts approximately the number of unique pages the query accessed. - MInnodbPagesDistinctSumPerSec float32 `json:"m_innodb_pages_distinct_sum_per_sec,omitempty"` - - // Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution. - MInnodbQueueWaitSumPerSec float32 `json:"m_innodb_queue_wait_sum_per_sec,omitempty"` - // Shows how long (in seconds) the query waited for row locks. MInnodbRecLockWaitSumPerSec float32 `json:"m_innodb_rec_lock_wait_sum_per_sec,omitempty"` - // Total number of local blocks dirtied by the statement. - MLocalBlksDirtiedSumPerSec float32 `json:"m_local_blks_dirtied_sum_per_sec,omitempty"` - - // Total number of local block cache hits by the statement. - MLocalBlksHitSumPerSec float32 `json:"m_local_blks_hit_sum_per_sec,omitempty"` + // Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution. + MInnodbQueueWaitSumPerSec float32 `json:"m_innodb_queue_wait_sum_per_sec,omitempty"` - // Total number of local blocks read by the statement. - MLocalBlksReadSumPerSec float32 `json:"m_local_blks_read_sum_per_sec,omitempty"` + // Counts approximately the number of unique pages the query accessed. + MInnodbPagesDistinctSumPerSec float32 `json:"m_innodb_pages_distinct_sum_per_sec,omitempty"` - // Total number of local blocks written by the statement. - MLocalBlksWrittenSumPerSec float32 `json:"m_local_blks_written_sum_per_sec,omitempty"` + // Shows how long the query is. + MQueryLengthSumPerSec float32 `json:"m_query_length_sum_per_sec,omitempty"` - // The time to acquire locks in seconds. - MLockTimeSumPerSec float32 `json:"m_lock_time_sum_per_sec,omitempty"` + // The number of bytes sent to all clients. + MBytesSentSumPerSec float32 `json:"m_bytes_sent_sum_per_sec,omitempty"` - // The number of merge passes that the sort algorithm has had to do. - MMergePassesSumPerSec float32 `json:"m_merge_passes_sum_per_sec,omitempty"` + // Number of temporary tables created on memory for the query. + MTmpTablesSumPerSec float32 `json:"m_tmp_tables_sum_per_sec,omitempty"` - // The number of queries without good index. - MNoGoodIndexUsedSumPerSec float32 `json:"m_no_good_index_used_sum_per_sec,omitempty"` + // Number of temporary tables created on disk for the query. + MTmpDiskTablesSumPerSec float32 `json:"m_tmp_disk_tables_sum_per_sec,omitempty"` - // The number of queries without index. - MNoIndexUsedSumPerSec float32 `json:"m_no_index_used_sum_per_sec,omitempty"` + // Total Size in bytes for all temporary tables used in the query. + MTmpTableSizesSumPerSec float32 `json:"m_tmp_table_sizes_sum_per_sec,omitempty"` // Boolean metrics: // - *_sum_per_sec - how many times this matric was true. @@ -572,38 +573,58 @@ type SparklineItems0 struct { // Query Cache hits. MQcHitSumPerSec float32 `json:"m_qc_hit_sum_per_sec,omitempty"` - // Shows how long the query is. - MQueryLengthSumPerSec float32 `json:"m_query_length_sum_per_sec,omitempty"` - - // The statement execution time in seconds. - MQueryTimeSumPerSec float32 `json:"m_query_time_sum_per_sec,omitempty"` + // The query performed a full table scan. + MFullScanSumPerSec float32 `json:"m_full_scan_sum_per_sec,omitempty"` - // The response length of the query result in bytes. - MResponseLengthSumPerSec float32 `json:"m_response_length_sum_per_sec,omitempty"` + // The query performed a full join (a join without indexes). + MFullJoinSumPerSec float32 `json:"m_full_join_sum_per_sec,omitempty"` - // Number of rows changed - UPDATE, DELETE, INSERT. - MRowsAffectedSumPerSec float32 `json:"m_rows_affected_sum_per_sec,omitempty"` + // The query created an implicit internal temporary table. + MTmpTableSumPerSec float32 `json:"m_tmp_table_sum_per_sec,omitempty"` - // Number of rows scanned - SELECT. - MRowsExaminedSumPerSec float32 `json:"m_rows_examined_sum_per_sec,omitempty"` + // The querys temporary table was stored on disk. + MTmpTableOnDiskSumPerSec float32 `json:"m_tmp_table_on_disk_sum_per_sec,omitempty"` - // The number of rows read from tables. - MRowsReadSumPerSec float32 `json:"m_rows_read_sum_per_sec,omitempty"` + // The query used a filesort. + MFilesortSumPerSec float32 `json:"m_filesort_sum_per_sec,omitempty"` - // The number of rows sent to the client. - MRowsSentSumPerSec float32 `json:"m_rows_sent_sum_per_sec,omitempty"` + // The filesort was performed on disk. + MFilesortOnDiskSumPerSec float32 `json:"m_filesort_on_disk_sum_per_sec,omitempty"` // The number of joins that used a range search on a reference table. MSelectFullRangeJoinSumPerSec float32 `json:"m_select_full_range_join_sum_per_sec,omitempty"` + // The number of joins that used ranges on the first table. + MSelectRangeSumPerSec float32 `json:"m_select_range_sum_per_sec,omitempty"` + // The number of joins without keys that check for key usage after each row. MSelectRangeCheckSumPerSec float32 `json:"m_select_range_check_sum_per_sec,omitempty"` - // The number of joins that used ranges on the first table. - MSelectRangeSumPerSec float32 `json:"m_select_range_sum_per_sec,omitempty"` + // The number of sorts that were done using ranges. + MSortRangeSumPerSec float32 `json:"m_sort_range_sum_per_sec,omitempty"` - // Total number of shared blocks dirtied by the statement. - MSharedBlksDirtiedSumPerSec float32 `json:"m_shared_blks_dirtied_sum_per_sec,omitempty"` + // The number of sorted rows. + MSortRowsSumPerSec float32 `json:"m_sort_rows_sum_per_sec,omitempty"` + + // The number of sorts that were done by scanning the table. + MSortScanSumPerSec float32 `json:"m_sort_scan_sum_per_sec,omitempty"` + + // The number of queries without index. + MNoIndexUsedSumPerSec float32 `json:"m_no_index_used_sum_per_sec,omitempty"` + + // The number of queries without good index. + MNoGoodIndexUsedSumPerSec float32 `json:"m_no_good_index_used_sum_per_sec,omitempty"` + + // MongoDB metrics. + // + // The number of returned documents. + MDocsReturnedSumPerSec float32 `json:"m_docs_returned_sum_per_sec,omitempty"` + + // The response length of the query result in bytes. + MResponseLengthSumPerSec float32 `json:"m_response_length_sum_per_sec,omitempty"` + + // The number of scanned documents. + MDocsScannedSumPerSec float32 `json:"m_docs_scanned_sum_per_sec,omitempty"` // PostgreSQL metrics. // @@ -613,17 +634,23 @@ type SparklineItems0 struct { // Total number of shared blocks read by the statement. MSharedBlksReadSumPerSec float32 `json:"m_shared_blks_read_sum_per_sec,omitempty"` + // Total number of shared blocks dirtied by the statement. + MSharedBlksDirtiedSumPerSec float32 `json:"m_shared_blks_dirtied_sum_per_sec,omitempty"` + // Total number of shared blocks written by the statement. MSharedBlksWrittenSumPerSec float32 `json:"m_shared_blks_written_sum_per_sec,omitempty"` - // The number of sorts that were done using ranges. - MSortRangeSumPerSec float32 `json:"m_sort_range_sum_per_sec,omitempty"` + // Total number of local block cache hits by the statement. + MLocalBlksHitSumPerSec float32 `json:"m_local_blks_hit_sum_per_sec,omitempty"` - // The number of sorted rows. - MSortRowsSumPerSec float32 `json:"m_sort_rows_sum_per_sec,omitempty"` + // Total number of local blocks read by the statement. + MLocalBlksReadSumPerSec float32 `json:"m_local_blks_read_sum_per_sec,omitempty"` - // The number of sorts that were done by scanning the table. - MSortScanSumPerSec float32 `json:"m_sort_scan_sum_per_sec,omitempty"` + // Total number of local blocks dirtied by the statement. + MLocalBlksDirtiedSumPerSec float32 `json:"m_local_blks_dirtied_sum_per_sec,omitempty"` + + // Total number of local blocks written by the statement. + MLocalBlksWrittenSumPerSec float32 `json:"m_local_blks_written_sum_per_sec,omitempty"` // Total number of temp blocks read by the statement. MTempBlksReadSumPerSec float32 `json:"m_temp_blks_read_sum_per_sec,omitempty"` @@ -631,38 +658,11 @@ type SparklineItems0 struct { // Total number of temp blocks written by the statement. MTempBlksWrittenSumPerSec float32 `json:"m_temp_blks_written_sum_per_sec,omitempty"` - // Number of temporary tables created on disk for the query. - MTmpDiskTablesSumPerSec float32 `json:"m_tmp_disk_tables_sum_per_sec,omitempty"` - - // The querys temporary table was stored on disk. - MTmpTableOnDiskSumPerSec float32 `json:"m_tmp_table_on_disk_sum_per_sec,omitempty"` - - // Total Size in bytes for all temporary tables used in the query. - MTmpTableSizesSumPerSec float32 `json:"m_tmp_table_sizes_sum_per_sec,omitempty"` - - // The query created an implicit internal temporary table. - MTmpTableSumPerSec float32 `json:"m_tmp_table_sum_per_sec,omitempty"` - - // Number of temporary tables created on memory for the query. - MTmpTablesSumPerSec float32 `json:"m_tmp_tables_sum_per_sec,omitempty"` - - // number of queries in bucket. - NumQueriesPerSec float32 `json:"num_queries_per_sec,omitempty"` - - // number of queries with errors. - NumQueriesWithErrorsPerSec float32 `json:"num_queries_with_errors_per_sec,omitempty"` - - // number of queries with warnings. - NumQueriesWithWarningsPerSec float32 `json:"num_queries_with_warnings_per_sec,omitempty"` - - // The serial number of the chart point from the largest time in the time interval to the lowest time in the time range. - Point int64 `json:"point,omitempty"` - - // Duration beetween two points. - TimeFrame int64 `json:"time_frame,omitempty"` + // Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). + MBlkReadTimeSumPerSec float32 `json:"m_blk_read_time_sum_per_sec,omitempty"` - // Time of point in format RFC3339. - Timestamp string `json:"timestamp,omitempty"` + // Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). + MBlkWriteTimeSumPerSec float32 `json:"m_blk_write_time_sum_per_sec,omitempty"` } // Validate validates this sparkline items0 @@ -693,29 +693,29 @@ swagger:model TotalsAnon */ type TotalsAnon struct { - // avg - Avg float32 `json:"avg,omitempty"` + // rate + Rate float32 `json:"rate,omitempty"` // cnt Cnt float32 `json:"cnt,omitempty"` - // max - Max float32 `json:"max,omitempty"` + // sum + Sum float32 `json:"sum,omitempty"` // min Min float32 `json:"min,omitempty"` + // max + Max float32 `json:"max,omitempty"` + + // avg + Avg float32 `json:"avg,omitempty"` + // p99 P99 float32 `json:"p99,omitempty"` // percent of total PercentOfTotal float32 `json:"percent_of_total,omitempty"` - - // rate - Rate float32 `json:"rate,omitempty"` - - // sum - Sum float32 `json:"sum,omitempty"` } // Validate validates this totals anon diff --git a/api/qanpb/json/client/object_details/get_query_example_responses.go b/api/qanpb/json/client/object_details/get_query_example_responses.go index a03baf4061..6e430d0c56 100644 --- a/api/qanpb/json/client/object_details/get_query_example_responses.go +++ b/api/qanpb/json/client/object_details/get_query_example_responses.go @@ -126,6 +126,14 @@ swagger:model GetQueryExampleBody */ type GetQueryExampleBody struct { + // period start from + // Format: date-time + PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` + + // period start to + // Format: date-time + PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` + // dimension value: ex: queryid - 1D410B4BE5060972. FilterBy string `json:"filter_by,omitempty"` @@ -137,29 +145,21 @@ type GetQueryExampleBody struct { // limit Limit int64 `json:"limit,omitempty"` - - // period start from - // Format: date-time - PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` - - // period start to - // Format: date-time - PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` } // Validate validates this get query example body func (o *GetQueryExampleBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateLabels(formats); err != nil { + if err := o.validatePeriodStartFrom(formats); err != nil { res = append(res, err) } - if err := o.validatePeriodStartFrom(formats); err != nil { + if err := o.validatePeriodStartTo(formats); err != nil { res = append(res, err) } - if err := o.validatePeriodStartTo(formats); err != nil { + if err := o.validateLabels(formats); err != nil { res = append(res, err) } @@ -169,52 +169,52 @@ func (o *GetQueryExampleBody) Validate(formats strfmt.Registry) error { return nil } -func (o *GetQueryExampleBody) validateLabels(formats strfmt.Registry) error { +func (o *GetQueryExampleBody) validatePeriodStartFrom(formats strfmt.Registry) error { - if swag.IsZero(o.Labels) { // not required + if swag.IsZero(o.PeriodStartFrom) { // not required return nil } - for i := 0; i < len(o.Labels); i++ { - if swag.IsZero(o.Labels[i]) { // not required - continue - } - - if o.Labels[i] != nil { - if err := o.Labels[i].Validate(formats); err != nil { - if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("body" + "." + "labels" + "." + strconv.Itoa(i)) - } - return err - } - } - + if err := validate.FormatOf("body"+"."+"period_start_from", "body", "date-time", o.PeriodStartFrom.String(), formats); err != nil { + return err } return nil } -func (o *GetQueryExampleBody) validatePeriodStartFrom(formats strfmt.Registry) error { +func (o *GetQueryExampleBody) validatePeriodStartTo(formats strfmt.Registry) error { - if swag.IsZero(o.PeriodStartFrom) { // not required + if swag.IsZero(o.PeriodStartTo) { // not required return nil } - if err := validate.FormatOf("body"+"."+"period_start_from", "body", "date-time", o.PeriodStartFrom.String(), formats); err != nil { + if err := validate.FormatOf("body"+"."+"period_start_to", "body", "date-time", o.PeriodStartTo.String(), formats); err != nil { return err } return nil } -func (o *GetQueryExampleBody) validatePeriodStartTo(formats strfmt.Registry) error { +func (o *GetQueryExampleBody) validateLabels(formats strfmt.Registry) error { - if swag.IsZero(o.PeriodStartTo) { // not required + if swag.IsZero(o.Labels) { // not required return nil } - if err := validate.FormatOf("body"+"."+"period_start_to", "body", "date-time", o.PeriodStartTo.String(), formats); err != nil { - return err + for i := 0; i < len(o.Labels); i++ { + if swag.IsZero(o.Labels[i]) { // not required + continue + } + + if o.Labels[i] != nil { + if err := o.Labels[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("body" + "." + "labels" + "." + strconv.Itoa(i)) + } + return err + } + } + } return nil @@ -350,22 +350,11 @@ type QueryExamplesItems0 struct { // example Example string `json:"example,omitempty"` - // ExampleFormat is format of query example: real or query without values. - // Enum: [EXAMPLE_FORMAT_INVALID EXAMPLE FINGERPRINT] - ExampleFormat *string `json:"example_format,omitempty"` - - // example metrics - ExampleMetrics string `json:"example_metrics,omitempty"` - - // ExampleType is a type of query example selected for this query class in given period of time. - // Enum: [EXAMPLE_TYPE_INVALID RANDOM SLOWEST FASTEST WITH_ERROR] - ExampleType *string `json:"example_type,omitempty"` - // is truncated IsTruncated int64 `json:"is_truncated,omitempty"` - // schema - Schema string `json:"schema,omitempty"` + // example metrics + ExampleMetrics string `json:"example_metrics,omitempty"` // service id ServiceID string `json:"service_id,omitempty"` @@ -373,8 +362,19 @@ type QueryExamplesItems0 struct { // service type ServiceType string `json:"service_type,omitempty"` + // schema + Schema string `json:"schema,omitempty"` + // tables Tables []string `json:"tables"` + + // ExampleFormat is format of query example: real or query without values. + // Enum: [EXAMPLE_FORMAT_INVALID EXAMPLE FINGERPRINT] + ExampleFormat *string `json:"example_format,omitempty"` + + // ExampleType is a type of query example selected for this query class in given period of time. + // Enum: [EXAMPLE_TYPE_INVALID RANDOM SLOWEST FASTEST WITH_ERROR] + ExampleType *string `json:"example_type,omitempty"` } // Validate validates this query examples items0 diff --git a/api/qanpb/json/client/profile/get_report_responses.go b/api/qanpb/json/client/profile/get_report_responses.go index d1290ee137..a13d460803 100644 --- a/api/qanpb/json/client/profile/get_report_responses.go +++ b/api/qanpb/json/client/profile/get_report_responses.go @@ -124,8 +124,13 @@ swagger:model GetReportBody */ type GetReportBody struct { - // columns - Columns []string `json:"columns"` + // period start from + // Format: date-time + PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` + + // period start to + // Format: date-time + PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` // group by GroupBy string `json:"group_by,omitempty"` @@ -133,40 +138,35 @@ type GetReportBody struct { // labels Labels []*LabelsItems0 `json:"labels"` - // limit - Limit int64 `json:"limit,omitempty"` + // columns + Columns []string `json:"columns"` - // main metric - MainMetric string `json:"main_metric,omitempty"` + // order by + OrderBy string `json:"order_by,omitempty"` // offset Offset int64 `json:"offset,omitempty"` - // order by - OrderBy string `json:"order_by,omitempty"` - - // period start from - // Format: date-time - PeriodStartFrom strfmt.DateTime `json:"period_start_from,omitempty"` + // limit + Limit int64 `json:"limit,omitempty"` - // period start to - // Format: date-time - PeriodStartTo strfmt.DateTime `json:"period_start_to,omitempty"` + // main metric + MainMetric string `json:"main_metric,omitempty"` } // Validate validates this get report body func (o *GetReportBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateLabels(formats); err != nil { + if err := o.validatePeriodStartFrom(formats); err != nil { res = append(res, err) } - if err := o.validatePeriodStartFrom(formats); err != nil { + if err := o.validatePeriodStartTo(formats); err != nil { res = append(res, err) } - if err := o.validatePeriodStartTo(formats); err != nil { + if err := o.validateLabels(formats); err != nil { res = append(res, err) } @@ -176,52 +176,52 @@ func (o *GetReportBody) Validate(formats strfmt.Registry) error { return nil } -func (o *GetReportBody) validateLabels(formats strfmt.Registry) error { +func (o *GetReportBody) validatePeriodStartFrom(formats strfmt.Registry) error { - if swag.IsZero(o.Labels) { // not required + if swag.IsZero(o.PeriodStartFrom) { // not required return nil } - for i := 0; i < len(o.Labels); i++ { - if swag.IsZero(o.Labels[i]) { // not required - continue - } - - if o.Labels[i] != nil { - if err := o.Labels[i].Validate(formats); err != nil { - if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("body" + "." + "labels" + "." + strconv.Itoa(i)) - } - return err - } - } - + if err := validate.FormatOf("body"+"."+"period_start_from", "body", "date-time", o.PeriodStartFrom.String(), formats); err != nil { + return err } return nil } -func (o *GetReportBody) validatePeriodStartFrom(formats strfmt.Registry) error { +func (o *GetReportBody) validatePeriodStartTo(formats strfmt.Registry) error { - if swag.IsZero(o.PeriodStartFrom) { // not required + if swag.IsZero(o.PeriodStartTo) { // not required return nil } - if err := validate.FormatOf("body"+"."+"period_start_from", "body", "date-time", o.PeriodStartFrom.String(), formats); err != nil { + if err := validate.FormatOf("body"+"."+"period_start_to", "body", "date-time", o.PeriodStartTo.String(), formats); err != nil { return err } return nil } -func (o *GetReportBody) validatePeriodStartTo(formats strfmt.Registry) error { +func (o *GetReportBody) validateLabels(formats strfmt.Registry) error { - if swag.IsZero(o.PeriodStartTo) { // not required + if swag.IsZero(o.Labels) { // not required return nil } - if err := validate.FormatOf("body"+"."+"period_start_to", "body", "date-time", o.PeriodStartTo.String(), formats); err != nil { - return err + for i := 0; i < len(o.Labels); i++ { + if swag.IsZero(o.Labels[i]) { // not required + continue + } + + if o.Labels[i] != nil { + if err := o.Labels[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("body" + "." + "labels" + "." + strconv.Itoa(i)) + } + return err + } + } + } return nil @@ -288,17 +288,17 @@ swagger:model GetReportOKBody */ type GetReportOKBody struct { - // limit - Limit int64 `json:"limit,omitempty"` + // total rows + TotalRows int64 `json:"total_rows,omitempty"` // offset Offset int64 `json:"offset,omitempty"` + // limit + Limit int64 `json:"limit,omitempty"` + // rows Rows []*RowsItems0 `json:"rows"` - - // total rows - TotalRows int64 `json:"total_rows,omitempty"` } // Validate validates this get report OK body @@ -398,29 +398,29 @@ swagger:model RowsItems0 */ type RowsItems0 struct { + // rank + Rank int64 `json:"rank,omitempty"` + // dimension Dimension string `json:"dimension,omitempty"` - // fingerprint - Fingerprint string `json:"fingerprint,omitempty"` - - // load - Load float32 `json:"load,omitempty"` - // metrics Metrics map[string]RowsItems0MetricsAnon `json:"metrics,omitempty"` + // sparkline + Sparkline []*RowsItems0SparklineItems0 `json:"sparkline"` + + // fingerprint + Fingerprint string `json:"fingerprint,omitempty"` + // num queries NumQueries int64 `json:"num_queries,omitempty"` // qps QPS float32 `json:"qps,omitempty"` - // rank - Rank int64 `json:"rank,omitempty"` - - // sparkline - Sparkline []*RowsItems0SparklineItems0 `json:"sparkline"` + // load + Load float32 `json:"load,omitempty"` } // Validate validates this rows items0 @@ -570,26 +570,26 @@ swagger:model RowsItems0MetricsAnonStats */ type RowsItems0MetricsAnonStats struct { - // avg - Avg float32 `json:"avg,omitempty"` + // rate + Rate float32 `json:"rate,omitempty"` // cnt Cnt float32 `json:"cnt,omitempty"` - // max - Max float32 `json:"max,omitempty"` + // sum + Sum float32 `json:"sum,omitempty"` // min Min float32 `json:"min,omitempty"` + // max + Max float32 `json:"max,omitempty"` + // p99 P99 float32 `json:"p99,omitempty"` - // rate - Rate float32 `json:"rate,omitempty"` - - // sum - Sum float32 `json:"sum,omitempty"` + // avg + Avg float32 `json:"avg,omitempty"` // sum per sec SumPerSec float32 `json:"sum_per_sec,omitempty"` @@ -624,79 +624,80 @@ swagger:model RowsItems0SparklineItems0 */ type RowsItems0SparklineItems0 struct { + // The serial number of the chart point from the largest time in the time interval to the lowest time in the time range. + Point int64 `json:"point,omitempty"` + + // Duration beetween two points. + TimeFrame int64 `json:"time_frame,omitempty"` + + // Time of point in format RFC3339. + Timestamp string `json:"timestamp,omitempty"` + // load is query_time / time_range. Load float32 `json:"load,omitempty"` - // Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). - MBlkReadTimeSumPerSec float32 `json:"m_blk_read_time_sum_per_sec,omitempty"` + // number of queries in bucket. + NumQueriesPerSec float32 `json:"num_queries_per_sec,omitempty"` - // Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). - MBlkWriteTimeSumPerSec float32 `json:"m_blk_write_time_sum_per_sec,omitempty"` + // number of queries with errors. + NumQueriesWithErrorsPerSec float32 `json:"num_queries_with_errors_per_sec,omitempty"` - // The number of bytes sent to all clients. - MBytesSentSumPerSec float32 `json:"m_bytes_sent_sum_per_sec,omitempty"` + // number of queries with warnings. + NumQueriesWithWarningsPerSec float32 `json:"num_queries_with_warnings_per_sec,omitempty"` - // MongoDB metrics. - // - // The number of returned documents. - MDocsReturnedSumPerSec float32 `json:"m_docs_returned_sum_per_sec,omitempty"` + // The statement execution time in seconds. + MQueryTimeSumPerSec float32 `json:"m_query_time_sum_per_sec,omitempty"` - // The number of scanned documents. - MDocsScannedSumPerSec float32 `json:"m_docs_scanned_sum_per_sec,omitempty"` + // The time to acquire locks in seconds. + MLockTimeSumPerSec float32 `json:"m_lock_time_sum_per_sec,omitempty"` - // The filesort was performed on disk. - MFilesortOnDiskSumPerSec float32 `json:"m_filesort_on_disk_sum_per_sec,omitempty"` + // The number of rows sent to the client. + MRowsSentSumPerSec float32 `json:"m_rows_sent_sum_per_sec,omitempty"` - // The query used a filesort. - MFilesortSumPerSec float32 `json:"m_filesort_sum_per_sec,omitempty"` + // Number of rows scanned - SELECT. + MRowsExaminedSumPerSec float32 `json:"m_rows_examined_sum_per_sec,omitempty"` - // The query performed a full join (a join without indexes). - MFullJoinSumPerSec float32 `json:"m_full_join_sum_per_sec,omitempty"` + // Number of rows changed - UPDATE, DELETE, INSERT. + MRowsAffectedSumPerSec float32 `json:"m_rows_affected_sum_per_sec,omitempty"` - // The query performed a full table scan. - MFullScanSumPerSec float32 `json:"m_full_scan_sum_per_sec,omitempty"` + // The number of rows read from tables. + MRowsReadSumPerSec float32 `json:"m_rows_read_sum_per_sec,omitempty"` - // Similar to innodb_IO_r_ops, but the unit is bytes. - MInnodbIorBytesSumPerSec float32 `json:"m_innodb_io_r_bytes_sum_per_sec,omitempty"` + // The number of merge passes that the sort algorithm has had to do. + MMergePassesSumPerSec float32 `json:"m_merge_passes_sum_per_sec,omitempty"` // Counts the number of page read operations scheduled. MInnodbIorOpsSumPerSec float32 `json:"m_innodb_io_r_ops_sum_per_sec,omitempty"` + // Similar to innodb_IO_r_ops, but the unit is bytes. + MInnodbIorBytesSumPerSec float32 `json:"m_innodb_io_r_bytes_sum_per_sec,omitempty"` + // Shows how long (in seconds) it took InnoDB to actually read the data from storage. MInnodbIorWaitSumPerSec float32 `json:"m_innodb_io_r_wait_sum_per_sec,omitempty"` - // Counts approximately the number of unique pages the query accessed. - MInnodbPagesDistinctSumPerSec float32 `json:"m_innodb_pages_distinct_sum_per_sec,omitempty"` - - // Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution. - MInnodbQueueWaitSumPerSec float32 `json:"m_innodb_queue_wait_sum_per_sec,omitempty"` - // Shows how long (in seconds) the query waited for row locks. MInnodbRecLockWaitSumPerSec float32 `json:"m_innodb_rec_lock_wait_sum_per_sec,omitempty"` - // Total number of local blocks dirtied by the statement. - MLocalBlksDirtiedSumPerSec float32 `json:"m_local_blks_dirtied_sum_per_sec,omitempty"` - - // Total number of local block cache hits by the statement. - MLocalBlksHitSumPerSec float32 `json:"m_local_blks_hit_sum_per_sec,omitempty"` + // Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution. + MInnodbQueueWaitSumPerSec float32 `json:"m_innodb_queue_wait_sum_per_sec,omitempty"` - // Total number of local blocks read by the statement. - MLocalBlksReadSumPerSec float32 `json:"m_local_blks_read_sum_per_sec,omitempty"` + // Counts approximately the number of unique pages the query accessed. + MInnodbPagesDistinctSumPerSec float32 `json:"m_innodb_pages_distinct_sum_per_sec,omitempty"` - // Total number of local blocks written by the statement. - MLocalBlksWrittenSumPerSec float32 `json:"m_local_blks_written_sum_per_sec,omitempty"` + // Shows how long the query is. + MQueryLengthSumPerSec float32 `json:"m_query_length_sum_per_sec,omitempty"` - // The time to acquire locks in seconds. - MLockTimeSumPerSec float32 `json:"m_lock_time_sum_per_sec,omitempty"` + // The number of bytes sent to all clients. + MBytesSentSumPerSec float32 `json:"m_bytes_sent_sum_per_sec,omitempty"` - // The number of merge passes that the sort algorithm has had to do. - MMergePassesSumPerSec float32 `json:"m_merge_passes_sum_per_sec,omitempty"` + // Number of temporary tables created on memory for the query. + MTmpTablesSumPerSec float32 `json:"m_tmp_tables_sum_per_sec,omitempty"` - // The number of queries without good index. - MNoGoodIndexUsedSumPerSec float32 `json:"m_no_good_index_used_sum_per_sec,omitempty"` + // Number of temporary tables created on disk for the query. + MTmpDiskTablesSumPerSec float32 `json:"m_tmp_disk_tables_sum_per_sec,omitempty"` - // The number of queries without index. - MNoIndexUsedSumPerSec float32 `json:"m_no_index_used_sum_per_sec,omitempty"` + // Total Size in bytes for all temporary tables used in the query. + MTmpTableSizesSumPerSec float32 `json:"m_tmp_table_sizes_sum_per_sec,omitempty"` // Boolean metrics: // - *_sum_per_sec - how many times this matric was true. @@ -704,38 +705,58 @@ type RowsItems0SparklineItems0 struct { // Query Cache hits. MQcHitSumPerSec float32 `json:"m_qc_hit_sum_per_sec,omitempty"` - // Shows how long the query is. - MQueryLengthSumPerSec float32 `json:"m_query_length_sum_per_sec,omitempty"` - - // The statement execution time in seconds. - MQueryTimeSumPerSec float32 `json:"m_query_time_sum_per_sec,omitempty"` + // The query performed a full table scan. + MFullScanSumPerSec float32 `json:"m_full_scan_sum_per_sec,omitempty"` - // The response length of the query result in bytes. - MResponseLengthSumPerSec float32 `json:"m_response_length_sum_per_sec,omitempty"` + // The query performed a full join (a join without indexes). + MFullJoinSumPerSec float32 `json:"m_full_join_sum_per_sec,omitempty"` - // Number of rows changed - UPDATE, DELETE, INSERT. - MRowsAffectedSumPerSec float32 `json:"m_rows_affected_sum_per_sec,omitempty"` + // The query created an implicit internal temporary table. + MTmpTableSumPerSec float32 `json:"m_tmp_table_sum_per_sec,omitempty"` - // Number of rows scanned - SELECT. - MRowsExaminedSumPerSec float32 `json:"m_rows_examined_sum_per_sec,omitempty"` + // The querys temporary table was stored on disk. + MTmpTableOnDiskSumPerSec float32 `json:"m_tmp_table_on_disk_sum_per_sec,omitempty"` - // The number of rows read from tables. - MRowsReadSumPerSec float32 `json:"m_rows_read_sum_per_sec,omitempty"` + // The query used a filesort. + MFilesortSumPerSec float32 `json:"m_filesort_sum_per_sec,omitempty"` - // The number of rows sent to the client. - MRowsSentSumPerSec float32 `json:"m_rows_sent_sum_per_sec,omitempty"` + // The filesort was performed on disk. + MFilesortOnDiskSumPerSec float32 `json:"m_filesort_on_disk_sum_per_sec,omitempty"` // The number of joins that used a range search on a reference table. MSelectFullRangeJoinSumPerSec float32 `json:"m_select_full_range_join_sum_per_sec,omitempty"` + // The number of joins that used ranges on the first table. + MSelectRangeSumPerSec float32 `json:"m_select_range_sum_per_sec,omitempty"` + // The number of joins without keys that check for key usage after each row. MSelectRangeCheckSumPerSec float32 `json:"m_select_range_check_sum_per_sec,omitempty"` - // The number of joins that used ranges on the first table. - MSelectRangeSumPerSec float32 `json:"m_select_range_sum_per_sec,omitempty"` + // The number of sorts that were done using ranges. + MSortRangeSumPerSec float32 `json:"m_sort_range_sum_per_sec,omitempty"` - // Total number of shared blocks dirtied by the statement. - MSharedBlksDirtiedSumPerSec float32 `json:"m_shared_blks_dirtied_sum_per_sec,omitempty"` + // The number of sorted rows. + MSortRowsSumPerSec float32 `json:"m_sort_rows_sum_per_sec,omitempty"` + + // The number of sorts that were done by scanning the table. + MSortScanSumPerSec float32 `json:"m_sort_scan_sum_per_sec,omitempty"` + + // The number of queries without index. + MNoIndexUsedSumPerSec float32 `json:"m_no_index_used_sum_per_sec,omitempty"` + + // The number of queries without good index. + MNoGoodIndexUsedSumPerSec float32 `json:"m_no_good_index_used_sum_per_sec,omitempty"` + + // MongoDB metrics. + // + // The number of returned documents. + MDocsReturnedSumPerSec float32 `json:"m_docs_returned_sum_per_sec,omitempty"` + + // The response length of the query result in bytes. + MResponseLengthSumPerSec float32 `json:"m_response_length_sum_per_sec,omitempty"` + + // The number of scanned documents. + MDocsScannedSumPerSec float32 `json:"m_docs_scanned_sum_per_sec,omitempty"` // PostgreSQL metrics. // @@ -745,17 +766,23 @@ type RowsItems0SparklineItems0 struct { // Total number of shared blocks read by the statement. MSharedBlksReadSumPerSec float32 `json:"m_shared_blks_read_sum_per_sec,omitempty"` + // Total number of shared blocks dirtied by the statement. + MSharedBlksDirtiedSumPerSec float32 `json:"m_shared_blks_dirtied_sum_per_sec,omitempty"` + // Total number of shared blocks written by the statement. MSharedBlksWrittenSumPerSec float32 `json:"m_shared_blks_written_sum_per_sec,omitempty"` - // The number of sorts that were done using ranges. - MSortRangeSumPerSec float32 `json:"m_sort_range_sum_per_sec,omitempty"` + // Total number of local block cache hits by the statement. + MLocalBlksHitSumPerSec float32 `json:"m_local_blks_hit_sum_per_sec,omitempty"` - // The number of sorted rows. - MSortRowsSumPerSec float32 `json:"m_sort_rows_sum_per_sec,omitempty"` + // Total number of local blocks read by the statement. + MLocalBlksReadSumPerSec float32 `json:"m_local_blks_read_sum_per_sec,omitempty"` - // The number of sorts that were done by scanning the table. - MSortScanSumPerSec float32 `json:"m_sort_scan_sum_per_sec,omitempty"` + // Total number of local blocks dirtied by the statement. + MLocalBlksDirtiedSumPerSec float32 `json:"m_local_blks_dirtied_sum_per_sec,omitempty"` + + // Total number of local blocks written by the statement. + MLocalBlksWrittenSumPerSec float32 `json:"m_local_blks_written_sum_per_sec,omitempty"` // Total number of temp blocks read by the statement. MTempBlksReadSumPerSec float32 `json:"m_temp_blks_read_sum_per_sec,omitempty"` @@ -763,38 +790,11 @@ type RowsItems0SparklineItems0 struct { // Total number of temp blocks written by the statement. MTempBlksWrittenSumPerSec float32 `json:"m_temp_blks_written_sum_per_sec,omitempty"` - // Number of temporary tables created on disk for the query. - MTmpDiskTablesSumPerSec float32 `json:"m_tmp_disk_tables_sum_per_sec,omitempty"` - - // The querys temporary table was stored on disk. - MTmpTableOnDiskSumPerSec float32 `json:"m_tmp_table_on_disk_sum_per_sec,omitempty"` - - // Total Size in bytes for all temporary tables used in the query. - MTmpTableSizesSumPerSec float32 `json:"m_tmp_table_sizes_sum_per_sec,omitempty"` - - // The query created an implicit internal temporary table. - MTmpTableSumPerSec float32 `json:"m_tmp_table_sum_per_sec,omitempty"` - - // Number of temporary tables created on memory for the query. - MTmpTablesSumPerSec float32 `json:"m_tmp_tables_sum_per_sec,omitempty"` - - // number of queries in bucket. - NumQueriesPerSec float32 `json:"num_queries_per_sec,omitempty"` - - // number of queries with errors. - NumQueriesWithErrorsPerSec float32 `json:"num_queries_with_errors_per_sec,omitempty"` - - // number of queries with warnings. - NumQueriesWithWarningsPerSec float32 `json:"num_queries_with_warnings_per_sec,omitempty"` - - // The serial number of the chart point from the largest time in the time interval to the lowest time in the time range. - Point int64 `json:"point,omitempty"` - - // Duration beetween two points. - TimeFrame int64 `json:"time_frame,omitempty"` + // Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). + MBlkReadTimeSumPerSec float32 `json:"m_blk_read_time_sum_per_sec,omitempty"` - // Time of point in format RFC3339. - Timestamp string `json:"timestamp,omitempty"` + // Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero). + MBlkWriteTimeSumPerSec float32 `json:"m_blk_write_time_sum_per_sec,omitempty"` } // Validate validates this rows items0 sparkline items0 diff --git a/api/qanpb/json/qanpb.json b/api/qanpb/json/qanpb.json index c949eb0b81..4319974c9d 100644 --- a/api/qanpb/json/qanpb.json +++ b/api/qanpb/json/qanpb.json @@ -32,15 +32,18 @@ "type": "object", "properties": { "main_metric_name": { - "type": "string" + "type": "string", + "x-order": 2 }, "period_start_from": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 0 }, "period_start_to": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 1 } } } @@ -67,20 +70,25 @@ "properties": { "main_metric_per_sec": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 }, "main_metric_percent": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, "value": { - "type": "string" + "type": "string", + "x-order": 0 } } - } + }, + "x-order": 0 } } - } + }, + "x-order": 0 } } } @@ -117,7 +125,8 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 0 } } } @@ -164,10 +173,12 @@ "type": "array", "items": { "type": "string" - } + }, + "x-order": 4 }, "group_by": { - "type": "string" + "type": "string", + "x-order": 2 }, "labels": { "type": "array", @@ -176,38 +187,47 @@ "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "x-order": 0 }, "value": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 1 } } - } + }, + "x-order": 3 }, "limit": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 7 }, "main_metric": { - "type": "string" + "type": "string", + "x-order": 8 }, "offset": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 6 }, "order_by": { - "type": "string" + "type": "string", + "x-order": 5 }, "period_start_from": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 0 }, "period_start_to": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 1 } } } @@ -222,11 +242,13 @@ "properties": { "limit": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 2 }, "offset": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 }, "rows": { "type": "array", @@ -235,14 +257,17 @@ "type": "object", "properties": { "dimension": { - "type": "string" + "type": "string", + "x-order": 1 }, "fingerprint": { - "type": "string" + "type": "string", + "x-order": 4 }, "load": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, "metrics": { "type": "object", @@ -256,52 +281,64 @@ "properties": { "avg": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "cnt": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, "max": { "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, "min": { "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, "p99": { "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, "rate": { "type": "number", - "format": "float" + "format": "float", + "x-order": 0 }, "sum": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 }, "sum_per_sec": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 } } } } - } + }, + "x-order": 2 }, "num_queries": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "qps": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "rank": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 0 }, "sparkline": { "type": "array", @@ -312,286 +349,344 @@ "load": { "description": "load is query_time / time_range.", "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, "m_blk_read_time_sum_per_sec": { "description": "Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", "type": "number", - "format": "float" + "format": "float", + "x-order": 53 }, "m_blk_write_time_sum_per_sec": { "description": "Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", "type": "number", - "format": "float" + "format": "float", + "x-order": 54 }, "m_bytes_sent_sum_per_sec": { "description": "The number of bytes sent to all clients.", "type": "number", - "format": "float" + "format": "float", + "x-order": 21 }, "m_docs_returned_sum_per_sec": { "description": "MongoDB metrics.\n\nThe number of returned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 40 }, "m_docs_scanned_sum_per_sec": { "description": "The number of scanned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 42 }, "m_filesort_on_disk_sum_per_sec": { "description": "The filesort was performed on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 31 }, "m_filesort_sum_per_sec": { "description": "The query used a filesort.", "type": "number", - "format": "float" + "format": "float", + "x-order": 30 }, "m_full_join_sum_per_sec": { "description": "The query performed a full join (a join without indexes).", "type": "number", - "format": "float" + "format": "float", + "x-order": 27 }, "m_full_scan_sum_per_sec": { "description": "The query performed a full table scan.", "type": "number", - "format": "float" + "format": "float", + "x-order": 26 }, "m_innodb_io_r_bytes_sum_per_sec": { "description": "Similar to innodb_IO_r_ops, but the unit is bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 15 }, "m_innodb_io_r_ops_sum_per_sec": { "description": "Counts the number of page read operations scheduled.", "type": "number", - "format": "float" + "format": "float", + "x-order": 14 }, "m_innodb_io_r_wait_sum_per_sec": { "description": "Shows how long (in seconds) it took InnoDB to actually read the data from storage.", "type": "number", - "format": "float" + "format": "float", + "x-order": 16 }, "m_innodb_pages_distinct_sum_per_sec": { "description": "Counts approximately the number of unique pages the query accessed.", "type": "number", - "format": "float" + "format": "float", + "x-order": 19 }, "m_innodb_queue_wait_sum_per_sec": { "description": "Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution.", "type": "number", - "format": "float" + "format": "float", + "x-order": 18 }, "m_innodb_rec_lock_wait_sum_per_sec": { "description": "Shows how long (in seconds) the query waited for row locks.", "type": "number", - "format": "float" + "format": "float", + "x-order": 17 }, "m_local_blks_dirtied_sum_per_sec": { "description": "Total number of local blocks dirtied by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 49 }, "m_local_blks_hit_sum_per_sec": { "description": "Total number of local block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 47 }, "m_local_blks_read_sum_per_sec": { "description": "Total number of local blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 48 }, "m_local_blks_written_sum_per_sec": { "description": "Total number of local blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 50 }, "m_lock_time_sum_per_sec": { "description": "The time to acquire locks in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 8 }, "m_merge_passes_sum_per_sec": { "description": "The number of merge passes that the sort algorithm has had to do.", "type": "number", - "format": "float" + "format": "float", + "x-order": 13 }, "m_no_good_index_used_sum_per_sec": { "description": "The number of queries without good index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 39 }, "m_no_index_used_sum_per_sec": { "description": "The number of queries without index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 38 }, "m_qc_hit_sum_per_sec": { "description": "Boolean metrics:\n- *_sum_per_sec - how many times this matric was true.\n\nQuery Cache hits.", "type": "number", - "format": "float" + "format": "float", + "x-order": 25 }, "m_query_length_sum_per_sec": { "description": "Shows how long the query is.", "type": "number", - "format": "float" + "format": "float", + "x-order": 20 }, "m_query_time_sum_per_sec": { "description": "The statement execution time in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, "m_response_length_sum_per_sec": { "description": "The response length of the query result in bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 41 }, "m_rows_affected_sum_per_sec": { "description": "Number of rows changed - UPDATE, DELETE, INSERT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 11 }, "m_rows_examined_sum_per_sec": { "description": "Number of rows scanned - SELECT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 10 }, "m_rows_read_sum_per_sec": { "description": "The number of rows read from tables.", "type": "number", - "format": "float" + "format": "float", + "x-order": 12 }, "m_rows_sent_sum_per_sec": { "description": "The number of rows sent to the client.", "type": "number", - "format": "float" + "format": "float", + "x-order": 9 }, "m_select_full_range_join_sum_per_sec": { "description": "The number of joins that used a range search on a reference table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 32 }, "m_select_range_check_sum_per_sec": { "description": "The number of joins without keys that check for key usage after each row.", "type": "number", - "format": "float" + "format": "float", + "x-order": 34 }, "m_select_range_sum_per_sec": { "description": "The number of joins that used ranges on the first table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 33 }, "m_shared_blks_dirtied_sum_per_sec": { "description": "Total number of shared blocks dirtied by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 45 }, "m_shared_blks_hit_sum_per_sec": { "description": "PostgreSQL metrics.\n\nTotal number of shared block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 43 }, "m_shared_blks_read_sum_per_sec": { "description": "Total number of shared blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 44 }, "m_shared_blks_written_sum_per_sec": { "description": "Total number of shared blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 46 }, "m_sort_range_sum_per_sec": { "description": "The number of sorts that were done using ranges.", "type": "number", - "format": "float" + "format": "float", + "x-order": 35 }, "m_sort_rows_sum_per_sec": { "description": "The number of sorted rows.", "type": "number", - "format": "float" + "format": "float", + "x-order": 36 }, "m_sort_scan_sum_per_sec": { "description": "The number of sorts that were done by scanning the table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 37 }, "m_temp_blks_read_sum_per_sec": { "description": "Total number of temp blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 51 }, "m_temp_blks_written_sum_per_sec": { "description": "Total number of temp blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 52 }, "m_tmp_disk_tables_sum_per_sec": { "description": "Number of temporary tables created on disk for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 23 }, "m_tmp_table_on_disk_sum_per_sec": { "description": "The querys temporary table was stored on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 29 }, "m_tmp_table_sizes_sum_per_sec": { "description": "Total Size in bytes for all temporary tables used in the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 24 }, "m_tmp_table_sum_per_sec": { "description": "The query created an implicit internal temporary table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 28 }, "m_tmp_tables_sum_per_sec": { "description": "Number of temporary tables created on memory for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 22 }, "num_queries_per_sec": { "description": "number of queries in bucket.", "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, "num_queries_with_errors_per_sec": { "description": "number of queries with errors.", "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, "num_queries_with_warnings_per_sec": { "description": "number of queries with warnings.", "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "point": { "description": "The serial number of the chart point from the largest time in the time interval to the lowest time in the time range.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 0 }, "time_frame": { "description": "Duration beetween two points.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 }, "timestamp": { "description": "Time of point in format RFC3339.", - "type": "string" + "type": "string", + "x-order": 2 } } - } + }, + "x-order": 3 } } - } + }, + "x-order": 3 }, "total_rows": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 0 } } } @@ -636,19 +731,23 @@ "properties": { "filter_by": { "description": "dimension value: ex: queryid - 1D410B4BE5060972.", - "type": "string" + "type": "string", + "x-order": 2 }, "group_by": { "description": "one of dimension: queryid | host ...", - "type": "string" + "type": "string", + "x-order": 3 }, "period_start_from": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 0 }, "period_start_to": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 1 } } } @@ -671,10 +770,12 @@ "type": "array", "items": { "type": "string" - } + }, + "x-order": 0 } } - } + }, + "x-order": 0 } } } @@ -719,17 +820,20 @@ "properties": { "filter_by": { "description": "dimension value: ex: queryid - 1D410B4BE5060972.", - "type": "string" + "type": "string", + "x-order": 2 }, "group_by": { "description": "one of dimension: queryid | host ...", - "type": "string" + "type": "string", + "x-order": 3 }, "include_only_fields": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 5 }, "labels": { "type": "array", @@ -738,24 +842,29 @@ "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "x-order": 0 }, "value": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 1 } } - } + }, + "x-order": 4 }, "period_start_from": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 0 }, "period_start_to": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 1 } } } @@ -776,38 +885,47 @@ "properties": { "avg": { "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, "cnt": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, "max": { "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, "min": { "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, "p99": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "percent_of_total": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, "rate": { "type": "number", - "format": "float" + "format": "float", + "x-order": 0 }, "sum": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 } } - } + }, + "x-order": 0 }, "sparkline": { "type": "array", @@ -818,279 +936,335 @@ "load": { "description": "load is query_time / time_range.", "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, "m_blk_read_time_sum_per_sec": { "description": "Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", "type": "number", - "format": "float" + "format": "float", + "x-order": 53 }, "m_blk_write_time_sum_per_sec": { "description": "Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", "type": "number", - "format": "float" + "format": "float", + "x-order": 54 }, "m_bytes_sent_sum_per_sec": { "description": "The number of bytes sent to all clients.", "type": "number", - "format": "float" + "format": "float", + "x-order": 21 }, "m_docs_returned_sum_per_sec": { "description": "MongoDB metrics.\n\nThe number of returned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 40 }, "m_docs_scanned_sum_per_sec": { "description": "The number of scanned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 42 }, "m_filesort_on_disk_sum_per_sec": { "description": "The filesort was performed on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 31 }, "m_filesort_sum_per_sec": { "description": "The query used a filesort.", "type": "number", - "format": "float" + "format": "float", + "x-order": 30 }, "m_full_join_sum_per_sec": { "description": "The query performed a full join (a join without indexes).", "type": "number", - "format": "float" + "format": "float", + "x-order": 27 }, "m_full_scan_sum_per_sec": { "description": "The query performed a full table scan.", "type": "number", - "format": "float" + "format": "float", + "x-order": 26 }, "m_innodb_io_r_bytes_sum_per_sec": { "description": "Similar to innodb_IO_r_ops, but the unit is bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 15 }, "m_innodb_io_r_ops_sum_per_sec": { "description": "Counts the number of page read operations scheduled.", "type": "number", - "format": "float" + "format": "float", + "x-order": 14 }, "m_innodb_io_r_wait_sum_per_sec": { "description": "Shows how long (in seconds) it took InnoDB to actually read the data from storage.", "type": "number", - "format": "float" + "format": "float", + "x-order": 16 }, "m_innodb_pages_distinct_sum_per_sec": { "description": "Counts approximately the number of unique pages the query accessed.", "type": "number", - "format": "float" + "format": "float", + "x-order": 19 }, "m_innodb_queue_wait_sum_per_sec": { "description": "Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution.", "type": "number", - "format": "float" + "format": "float", + "x-order": 18 }, "m_innodb_rec_lock_wait_sum_per_sec": { "description": "Shows how long (in seconds) the query waited for row locks.", "type": "number", - "format": "float" + "format": "float", + "x-order": 17 }, "m_local_blks_dirtied_sum_per_sec": { "description": "Total number of local blocks dirtied by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 49 }, "m_local_blks_hit_sum_per_sec": { "description": "Total number of local block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 47 }, "m_local_blks_read_sum_per_sec": { "description": "Total number of local blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 48 }, "m_local_blks_written_sum_per_sec": { "description": "Total number of local blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 50 }, "m_lock_time_sum_per_sec": { "description": "The time to acquire locks in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 8 }, "m_merge_passes_sum_per_sec": { "description": "The number of merge passes that the sort algorithm has had to do.", "type": "number", - "format": "float" + "format": "float", + "x-order": 13 }, "m_no_good_index_used_sum_per_sec": { "description": "The number of queries without good index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 39 }, "m_no_index_used_sum_per_sec": { "description": "The number of queries without index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 38 }, "m_qc_hit_sum_per_sec": { "description": "Boolean metrics:\n- *_sum_per_sec - how many times this matric was true.\n\nQuery Cache hits.", "type": "number", - "format": "float" + "format": "float", + "x-order": 25 }, "m_query_length_sum_per_sec": { "description": "Shows how long the query is.", "type": "number", - "format": "float" + "format": "float", + "x-order": 20 }, "m_query_time_sum_per_sec": { "description": "The statement execution time in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, "m_response_length_sum_per_sec": { "description": "The response length of the query result in bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 41 }, "m_rows_affected_sum_per_sec": { "description": "Number of rows changed - UPDATE, DELETE, INSERT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 11 }, "m_rows_examined_sum_per_sec": { "description": "Number of rows scanned - SELECT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 10 }, "m_rows_read_sum_per_sec": { "description": "The number of rows read from tables.", "type": "number", - "format": "float" + "format": "float", + "x-order": 12 }, "m_rows_sent_sum_per_sec": { "description": "The number of rows sent to the client.", "type": "number", - "format": "float" + "format": "float", + "x-order": 9 }, "m_select_full_range_join_sum_per_sec": { "description": "The number of joins that used a range search on a reference table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 32 }, "m_select_range_check_sum_per_sec": { "description": "The number of joins without keys that check for key usage after each row.", "type": "number", - "format": "float" + "format": "float", + "x-order": 34 }, "m_select_range_sum_per_sec": { "description": "The number of joins that used ranges on the first table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 33 }, "m_shared_blks_dirtied_sum_per_sec": { "description": "Total number of shared blocks dirtied by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 45 }, "m_shared_blks_hit_sum_per_sec": { "description": "PostgreSQL metrics.\n\nTotal number of shared block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 43 }, "m_shared_blks_read_sum_per_sec": { "description": "Total number of shared blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 44 }, "m_shared_blks_written_sum_per_sec": { "description": "Total number of shared blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 46 }, "m_sort_range_sum_per_sec": { "description": "The number of sorts that were done using ranges.", "type": "number", - "format": "float" + "format": "float", + "x-order": 35 }, "m_sort_rows_sum_per_sec": { "description": "The number of sorted rows.", "type": "number", - "format": "float" + "format": "float", + "x-order": 36 }, "m_sort_scan_sum_per_sec": { "description": "The number of sorts that were done by scanning the table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 37 }, "m_temp_blks_read_sum_per_sec": { "description": "Total number of temp blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 51 }, "m_temp_blks_written_sum_per_sec": { "description": "Total number of temp blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 52 }, "m_tmp_disk_tables_sum_per_sec": { "description": "Number of temporary tables created on disk for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 23 }, "m_tmp_table_on_disk_sum_per_sec": { "description": "The querys temporary table was stored on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 29 }, "m_tmp_table_sizes_sum_per_sec": { "description": "Total Size in bytes for all temporary tables used in the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 24 }, "m_tmp_table_sum_per_sec": { "description": "The query created an implicit internal temporary table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 28 }, "m_tmp_tables_sum_per_sec": { "description": "Number of temporary tables created on memory for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 22 }, "num_queries_per_sec": { "description": "number of queries in bucket.", "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, "num_queries_with_errors_per_sec": { "description": "number of queries with errors.", "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, "num_queries_with_warnings_per_sec": { "description": "number of queries with warnings.", "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "point": { "description": "The serial number of the chart point from the largest time in the time interval to the lowest time in the time range.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 0 }, "time_frame": { "description": "Duration beetween two points.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 }, "timestamp": { "description": "Time of point in format RFC3339.", - "type": "string" + "type": "string", + "x-order": 2 } } - } + }, + "x-order": 1 }, "totals": { "type": "object", @@ -1100,38 +1274,47 @@ "properties": { "avg": { "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, "cnt": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, "max": { "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, "min": { "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, "p99": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "percent_of_total": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, "rate": { "type": "number", - "format": "float" + "format": "float", + "x-order": 0 }, "sum": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 } } - } + }, + "x-order": 2 } } } @@ -1176,11 +1359,13 @@ "properties": { "filter_by": { "description": "dimension value: ex: queryid - 1D410B4BE5060972.", - "type": "string" + "type": "string", + "x-order": 2 }, "group_by": { "description": "one of dimension: queryid | host ...", - "type": "string" + "type": "string", + "x-order": 3 }, "labels": { "type": "array", @@ -1189,28 +1374,34 @@ "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "x-order": 0 }, "value": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 1 } } - } + }, + "x-order": 4 }, "limit": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 }, "period_start_from": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 0 }, "period_start_to": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 1 } } } @@ -1230,7 +1421,8 @@ "type": "object", "properties": { "example": { - "type": "string" + "type": "string", + "x-order": 0 }, "example_format": { "description": "ExampleFormat is format of query example: real or query without values.", @@ -1243,7 +1435,8 @@ ] }, "example_metrics": { - "type": "string" + "type": "string", + "x-order": 4 }, "example_type": { "description": "ExampleType is a type of query example selected for this query class in given period of time.", @@ -1259,25 +1452,31 @@ }, "is_truncated": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 }, "schema": { - "type": "string" + "type": "string", + "x-order": 7 }, "service_id": { - "type": "string" + "type": "string", + "x-order": 5 }, "service_type": { - "type": "string" + "type": "string", + "x-order": 6 }, "tables": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 8 } } - } + }, + "x-order": 0 } } } diff --git a/api/serverpb/json/client/server/change_settings_responses.go b/api/serverpb/json/client/server/change_settings_responses.go index b1b742a8c2..5435d70838 100644 --- a/api/serverpb/json/client/server/change_settings_responses.go +++ b/api/serverpb/json/client/server/change_settings_responses.go @@ -122,14 +122,14 @@ swagger:model ChangeSettingsBody */ type ChangeSettingsBody struct { - // A number of full days for Prometheus and QAN data retention. Should have a suffix in JSON: 2592000s, 43200m, 720h. - DataRetention string `json:"data_retention,omitempty"` + // enable telemetry + EnableTelemetry bool `json:"enable_telemetry,omitempty"` // disable telemetry DisableTelemetry bool `json:"disable_telemetry,omitempty"` - // enable telemetry - EnableTelemetry bool `json:"enable_telemetry,omitempty"` + // A number of full days for Prometheus and QAN data retention. Should have a suffix in JSON: 2592000s, 43200m, 720h. + DataRetention string `json:"data_retention,omitempty"` // metrics resolutions MetricsResolutions *ChangeSettingsParamsBodyMetricsResolutions `json:"metrics_resolutions,omitempty"` @@ -287,17 +287,17 @@ swagger:model ChangeSettingsOKBodySettings */ type ChangeSettingsOKBodySettings struct { + // updates disabled + UpdatesDisabled bool `json:"updates_disabled,omitempty"` + + // telemetry enabled + TelemetryEnabled bool `json:"telemetry_enabled,omitempty"` + // data retention DataRetention string `json:"data_retention,omitempty"` // metrics resolutions MetricsResolutions *ChangeSettingsOKBodySettingsMetricsResolutions `json:"metrics_resolutions,omitempty"` - - // telemetry enabled - TelemetryEnabled bool `json:"telemetry_enabled,omitempty"` - - // updates disabled - UpdatesDisabled bool `json:"updates_disabled,omitempty"` } // Validate validates this change settings OK body settings @@ -358,11 +358,11 @@ type ChangeSettingsOKBodySettingsMetricsResolutions struct { // High resolution. Should have a suffix in JSON: 1s, 1m, 1h. Hr string `json:"hr,omitempty"` - // Low resolution. Should have a suffix in JSON: 1s, 1m, 1h. - Lr string `json:"lr,omitempty"` - // Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h. Mr string `json:"mr,omitempty"` + + // Low resolution. Should have a suffix in JSON: 1s, 1m, 1h. + Lr string `json:"lr,omitempty"` } // Validate validates this change settings OK body settings metrics resolutions @@ -396,11 +396,11 @@ type ChangeSettingsParamsBodyMetricsResolutions struct { // High resolution. Should have a suffix in JSON: 1s, 1m, 1h. Hr string `json:"hr,omitempty"` - // Low resolution. Should have a suffix in JSON: 1s, 1m, 1h. - Lr string `json:"lr,omitempty"` - // Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h. Mr string `json:"mr,omitempty"` + + // Low resolution. Should have a suffix in JSON: 1s, 1m, 1h. + Lr string `json:"lr,omitempty"` } // Validate validates this change settings params body metrics resolutions diff --git a/api/serverpb/json/client/server/check_updates_responses.go b/api/serverpb/json/client/server/check_updates_responses.go index 6f0eddb6c1..b343802b04 100644 --- a/api/serverpb/json/client/server/check_updates_responses.go +++ b/api/serverpb/json/client/server/check_updates_responses.go @@ -193,32 +193,32 @@ swagger:model CheckUpdatesOKBody */ type CheckUpdatesOKBody struct { - // installed - Installed *CheckUpdatesOKBodyInstalled `json:"installed,omitempty"` + // True if there is a PMM Server update available. + UpdateAvailable bool `json:"update_available,omitempty"` + + // Latest available PMM Server release announcement URL. + LatestNewsURL string `json:"latest_news_url,omitempty"` // Last check time. // Format: date-time LastCheck strfmt.DateTime `json:"last_check,omitempty"` + // installed + Installed *CheckUpdatesOKBodyInstalled `json:"installed,omitempty"` + // latest Latest *CheckUpdatesOKBodyLatest `json:"latest,omitempty"` - - // Latest available PMM Server release announcement URL. - LatestNewsURL string `json:"latest_news_url,omitempty"` - - // True if there is a PMM Server update available. - UpdateAvailable bool `json:"update_available,omitempty"` } // Validate validates this check updates OK body func (o *CheckUpdatesOKBody) Validate(formats strfmt.Registry) error { var res []error - if err := o.validateInstalled(formats); err != nil { + if err := o.validateLastCheck(formats); err != nil { res = append(res, err) } - if err := o.validateLastCheck(formats); err != nil { + if err := o.validateInstalled(formats); err != nil { res = append(res, err) } @@ -232,32 +232,32 @@ func (o *CheckUpdatesOKBody) Validate(formats strfmt.Registry) error { return nil } -func (o *CheckUpdatesOKBody) validateInstalled(formats strfmt.Registry) error { +func (o *CheckUpdatesOKBody) validateLastCheck(formats strfmt.Registry) error { - if swag.IsZero(o.Installed) { // not required + if swag.IsZero(o.LastCheck) { // not required return nil } - if o.Installed != nil { - if err := o.Installed.Validate(formats); err != nil { - if ve, ok := err.(*errors.Validation); ok { - return ve.ValidateName("checkUpdatesOk" + "." + "installed") - } - return err - } + if err := validate.FormatOf("checkUpdatesOk"+"."+"last_check", "body", "date-time", o.LastCheck.String(), formats); err != nil { + return err } return nil } -func (o *CheckUpdatesOKBody) validateLastCheck(formats strfmt.Registry) error { +func (o *CheckUpdatesOKBody) validateInstalled(formats strfmt.Registry) error { - if swag.IsZero(o.LastCheck) { // not required + if swag.IsZero(o.Installed) { // not required return nil } - if err := validate.FormatOf("checkUpdatesOk"+"."+"last_check", "body", "date-time", o.LastCheck.String(), formats); err != nil { - return err + if o.Installed != nil { + if err := o.Installed.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("checkUpdatesOk" + "." + "installed") + } + return err + } } return nil @@ -304,15 +304,15 @@ swagger:model CheckUpdatesOKBodyInstalled */ type CheckUpdatesOKBodyInstalled struct { + // User-visible version. + Version string `json:"version,omitempty"` + // Full version for debugging. FullVersion string `json:"full_version,omitempty"` // Build or release date. // Format: date-time Timestamp strfmt.DateTime `json:"timestamp,omitempty"` - - // User-visible version. - Version string `json:"version,omitempty"` } // Validate validates this check updates OK body installed @@ -365,15 +365,15 @@ swagger:model CheckUpdatesOKBodyLatest */ type CheckUpdatesOKBodyLatest struct { + // User-visible version. + Version string `json:"version,omitempty"` + // Full version for debugging. FullVersion string `json:"full_version,omitempty"` // Build or release date. // Format: date-time Timestamp strfmt.DateTime `json:"timestamp,omitempty"` - - // User-visible version. - Version string `json:"version,omitempty"` } // Validate validates this check updates OK body latest diff --git a/api/serverpb/json/client/server/get_settings_responses.go b/api/serverpb/json/client/server/get_settings_responses.go index 9ab816068d..4c5827be39 100644 --- a/api/serverpb/json/client/server/get_settings_responses.go +++ b/api/serverpb/json/client/server/get_settings_responses.go @@ -219,17 +219,17 @@ swagger:model GetSettingsOKBodySettings */ type GetSettingsOKBodySettings struct { + // updates disabled + UpdatesDisabled bool `json:"updates_disabled,omitempty"` + + // telemetry enabled + TelemetryEnabled bool `json:"telemetry_enabled,omitempty"` + // data retention DataRetention string `json:"data_retention,omitempty"` // metrics resolutions MetricsResolutions *GetSettingsOKBodySettingsMetricsResolutions `json:"metrics_resolutions,omitempty"` - - // telemetry enabled - TelemetryEnabled bool `json:"telemetry_enabled,omitempty"` - - // updates disabled - UpdatesDisabled bool `json:"updates_disabled,omitempty"` } // Validate validates this get settings OK body settings @@ -290,11 +290,11 @@ type GetSettingsOKBodySettingsMetricsResolutions struct { // High resolution. Should have a suffix in JSON: 1s, 1m, 1h. Hr string `json:"hr,omitempty"` - // Low resolution. Should have a suffix in JSON: 1s, 1m, 1h. - Lr string `json:"lr,omitempty"` - // Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h. Mr string `json:"mr,omitempty"` + + // Low resolution. Should have a suffix in JSON: 1s, 1m, 1h. + Lr string `json:"lr,omitempty"` } // Validate validates this get settings OK body settings metrics resolutions diff --git a/api/serverpb/json/client/server/update_status_responses.go b/api/serverpb/json/client/server/update_status_responses.go index 972335b74d..1f266796dd 100644 --- a/api/serverpb/json/client/server/update_status_responses.go +++ b/api/serverpb/json/client/server/update_status_responses.go @@ -194,14 +194,14 @@ swagger:model UpdateStatusOKBody */ type UpdateStatusOKBody struct { - // True when update is done. - Done bool `json:"done,omitempty"` - // Progress log lines. LogLines []string `json:"log_lines"` // Progress log offset for the next request. LogOffset int64 `json:"log_offset,omitempty"` + + // True when update is done. + Done bool `json:"done,omitempty"` } // Validate validates this update status OK body diff --git a/api/serverpb/json/client/server/version_responses.go b/api/serverpb/json/client/server/version_responses.go index e8a4dfa956..9da927835f 100644 --- a/api/serverpb/json/client/server/version_responses.go +++ b/api/serverpb/json/client/server/version_responses.go @@ -161,14 +161,14 @@ swagger:model VersionOKBody */ type VersionOKBody struct { + // PMM Server version. + Version string `json:"version,omitempty"` + // managed Managed *VersionOKBodyManaged `json:"managed,omitempty"` // server Server *VersionOKBodyServer `json:"server,omitempty"` - - // PMM Server version. - Version string `json:"version,omitempty"` } // Validate validates this version OK body @@ -248,15 +248,15 @@ swagger:model VersionOKBodyManaged */ type VersionOKBodyManaged struct { + // User-visible version. + Version string `json:"version,omitempty"` + // Full version for debugging. FullVersion string `json:"full_version,omitempty"` // Build or release date. // Format: date-time Timestamp strfmt.DateTime `json:"timestamp,omitempty"` - - // User-visible version. - Version string `json:"version,omitempty"` } // Validate validates this version OK body managed @@ -309,15 +309,15 @@ swagger:model VersionOKBodyServer */ type VersionOKBodyServer struct { + // User-visible version. + Version string `json:"version,omitempty"` + // Full version for debugging. FullVersion string `json:"full_version,omitempty"` // Build or release date. // Format: date-time Timestamp strfmt.DateTime `json:"timestamp,omitempty"` - - // User-visible version. - Version string `json:"version,omitempty"` } // Validate validates this version OK body server diff --git a/api/serverpb/json/serverpb.json b/api/serverpb/json/serverpb.json index 93965d6d91..c6161da56e 100644 --- a/api/serverpb/json/serverpb.json +++ b/api/serverpb/json/serverpb.json @@ -32,15 +32,18 @@ "properties": { "data_retention": { "description": "A number of full days for Prometheus and QAN data retention. Should have a suffix in JSON: 2592000s, 43200m, 720h.", - "type": "string" + "type": "string", + "x-order": 3 }, "disable_telemetry": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "enable_telemetry": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "metrics_resolutions": { "description": "MetricsResolutions represents Prometheus exporters metrics resolutions.", @@ -48,15 +51,18 @@ "properties": { "hr": { "description": "High resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 0 }, "lr": { "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 2 }, "mr": { "description": "Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -75,7 +81,8 @@ "type": "object", "properties": { "data_retention": { - "type": "string" + "type": "string", + "x-order": 3 }, "metrics_resolutions": { "description": "MetricsResolutions represents Prometheus exporters metrics resolutions.", @@ -83,25 +90,30 @@ "properties": { "hr": { "description": "High resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 0 }, "lr": { "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 2 }, "mr": { "description": "Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 1 } } }, "telemetry_enabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "updates_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 } } } @@ -158,7 +170,8 @@ "type": "object", "properties": { "data_retention": { - "type": "string" + "type": "string", + "x-order": 3 }, "metrics_resolutions": { "description": "MetricsResolutions represents Prometheus exporters metrics resolutions.", @@ -166,25 +179,30 @@ "properties": { "hr": { "description": "High resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 0 }, "lr": { "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 2 }, "mr": { "description": "Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 1 } } }, "telemetry_enabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, "updates_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 } } } @@ -231,7 +249,8 @@ "force": { "description": "If false, cached information may be returned.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 } } } @@ -249,23 +268,27 @@ "properties": { "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 2 }, "version": { "description": "User-visible version.", - "type": "string" + "type": "string", + "x-order": 0 } } }, "last_check": { "description": "Last check time.", "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 4 }, "latest": { "description": "VersionInfo describes component version, or PMM Server as a whole.", @@ -273,27 +296,32 @@ "properties": { "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 2 }, "version": { "description": "User-visible version.", - "type": "string" + "type": "string", + "x-order": 0 } } }, "latest_news_url": { "description": "Latest available PMM Server release announcement URL.", - "type": "string" + "type": "string", + "x-order": 3 }, "update_available": { "description": "True if there is a PMM Server update available.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 } } } @@ -345,12 +373,14 @@ "properties": { "auth_token": { "description": "Authentication token for getting update statuses.", - "type": "string" + "type": "string", + "x-order": 0 }, "log_offset": { "description": "Progress log offset.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 } } } @@ -394,12 +424,14 @@ "properties": { "auth_token": { "description": "Authentication token.", - "type": "string" + "type": "string", + "x-order": 0 }, "log_offset": { "description": "Progress log offset.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 } } } @@ -414,19 +446,22 @@ "done": { "description": "True when update is done.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, "log_lines": { "description": "Progress log lines.", "type": "array", "items": { "type": "string" - } + }, + "x-order": 0 }, "log_offset": { "description": "Progress log offset for the next request.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 } } } @@ -516,16 +551,19 @@ "properties": { "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 2 }, "version": { "description": "User-visible version.", - "type": "string" + "type": "string", + "x-order": 0 } } }, @@ -535,22 +573,26 @@ "properties": { "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 2 }, "version": { "description": "User-visible version.", - "type": "string" + "type": "string", + "x-order": 0 } } }, "version": { "description": "PMM Server version.", - "type": "string" + "type": "string", + "x-order": 0 } } } diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json index 74f576ed23..551e0a12e1 100644 --- a/api/swagger/swagger.json +++ b/api/swagger/swagger.json @@ -31,16 +31,19 @@ "description": "FiltersRequest contains period for which we need filters.", "type": "object", "properties": { - "main_metric_name": { - "type": "string" - }, "period_start_from": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 0 }, "period_start_to": { "type": "string", - "format": "date-time" + "format": "date-time", + "x-order": 1 + }, + "main_metric_name": { + "type": "string", + "x-order": 2 } } } @@ -65,22 +68,27 @@ "description": "Values is label values and main metric percent and per second.", "type": "object", "properties": { - "main_metric_per_sec": { - "type": "number", - "format": "float" + "value": { + "type": "string", + "x-order": 0 }, "main_metric_percent": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, - "value": { - "type": "string" + "main_metric_per_sec": { + "type": "number", + "format": "float", + "x-order": 2 } } - } + }, + "x-order": 0 } } - } + }, + "x-order": 0 } } } @@ -117,7 +125,8 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 0 } } } @@ -160,14 +169,19 @@ "description": "ReportRequest defines filtering of metrics report for db server or other dimentions.", "type": "object", "properties": { - "columns": { - "type": "array", - "items": { - "type": "string" - } + "period_start_from": { + "type": "string", + "format": "date-time", + "x-order": 0 + }, + "period_start_to": { + "type": "string", + "format": "date-time", + "x-order": 1 }, "group_by": { - "type": "string" + "type": "string", + "x-order": 2 }, "labels": { "type": "array", @@ -176,38 +190,44 @@ "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "x-order": 0 }, "value": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 1 } } - } + }, + "x-order": 3 }, - "limit": { - "type": "integer", - "format": "int64" + "columns": { + "type": "array", + "items": { + "type": "string" + }, + "x-order": 4 }, - "main_metric": { - "type": "string" + "order_by": { + "type": "string", + "x-order": 5 }, "offset": { "type": "integer", - "format": "int64" - }, - "order_by": { - "type": "string" + "format": "int64", + "x-order": 6 }, - "period_start_from": { - "type": "string", - "format": "date-time" + "limit": { + "type": "integer", + "format": "int64", + "x-order": 7 }, - "period_start_to": { + "main_metric": { "type": "string", - "format": "date-time" + "x-order": 8 } } } @@ -220,13 +240,20 @@ "description": "ReportReply is list of reports per quieryids, hosts etc.", "type": "object", "properties": { - "limit": { + "total_rows": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 0 }, "offset": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 + }, + "limit": { + "type": "integer", + "format": "int64", + "x-order": 2 }, "rows": { "type": "array", @@ -234,15 +261,14 @@ "description": "Row define metrics for selected dimention.", "type": "object", "properties": { - "dimension": { - "type": "string" - }, - "fingerprint": { - "type": "string" + "rank": { + "type": "integer", + "format": "int64", + "x-order": 0 }, - "load": { - "type": "number", - "format": "float" + "dimension": { + "type": "string", + "x-order": 1 }, "metrics": { "type": "object", @@ -254,54 +280,51 @@ "description": "Stat is statistics of specific metric.", "type": "object", "properties": { - "avg": { + "rate": { "type": "number", - "format": "float" + "format": "float", + "x-order": 0 }, "cnt": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, - "max": { + "sum": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 }, "min": { "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, - "p99": { + "max": { "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, - "rate": { + "p99": { "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, - "sum": { + "avg": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, "sum_per_sec": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 } } } } - } - }, - "num_queries": { - "type": "integer", - "format": "int64" - }, - "qps": { - "type": "number", - "format": "float" - }, - "rank": { - "type": "integer", - "format": "int64" + }, + "x-order": 2 }, "sparkline": { "type": "array", @@ -309,289 +332,361 @@ "description": "Point contains values that represents abscissa (time) and ordinate (volume etc.)\nof every point in a coordinate system of Sparklines.", "type": "object", "properties": { + "point": { + "description": "The serial number of the chart point from the largest time in the time interval to the lowest time in the time range.", + "type": "integer", + "format": "int64", + "x-order": 0 + }, + "time_frame": { + "description": "Duration beetween two points.", + "type": "integer", + "format": "int64", + "x-order": 1 + }, + "timestamp": { + "description": "Time of point in format RFC3339.", + "type": "string", + "x-order": 2 + }, "load": { "description": "load is query_time / time_range.", "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, - "m_blk_read_time_sum_per_sec": { - "description": "Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "num_queries_per_sec": { + "description": "number of queries in bucket.", "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, - "m_blk_write_time_sum_per_sec": { - "description": "Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "num_queries_with_errors_per_sec": { + "description": "number of queries with errors.", "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, - "m_bytes_sent_sum_per_sec": { - "description": "The number of bytes sent to all clients.", + "num_queries_with_warnings_per_sec": { + "description": "number of queries with warnings.", "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, - "m_docs_returned_sum_per_sec": { - "description": "MongoDB metrics.\n\nThe number of returned documents.", + "m_query_time_sum_per_sec": { + "description": "The statement execution time in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, - "m_docs_scanned_sum_per_sec": { - "description": "The number of scanned documents.", + "m_lock_time_sum_per_sec": { + "description": "The time to acquire locks in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 8 }, - "m_filesort_on_disk_sum_per_sec": { - "description": "The filesort was performed on disk.", + "m_rows_sent_sum_per_sec": { + "description": "The number of rows sent to the client.", "type": "number", - "format": "float" + "format": "float", + "x-order": 9 }, - "m_filesort_sum_per_sec": { - "description": "The query used a filesort.", + "m_rows_examined_sum_per_sec": { + "description": "Number of rows scanned - SELECT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 10 }, - "m_full_join_sum_per_sec": { - "description": "The query performed a full join (a join without indexes).", + "m_rows_affected_sum_per_sec": { + "description": "Number of rows changed - UPDATE, DELETE, INSERT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 11 }, - "m_full_scan_sum_per_sec": { - "description": "The query performed a full table scan.", + "m_rows_read_sum_per_sec": { + "description": "The number of rows read from tables.", "type": "number", - "format": "float" + "format": "float", + "x-order": 12 }, - "m_innodb_io_r_bytes_sum_per_sec": { - "description": "Similar to innodb_IO_r_ops, but the unit is bytes.", + "m_merge_passes_sum_per_sec": { + "description": "The number of merge passes that the sort algorithm has had to do.", "type": "number", - "format": "float" + "format": "float", + "x-order": 13 }, "m_innodb_io_r_ops_sum_per_sec": { "description": "Counts the number of page read operations scheduled.", "type": "number", - "format": "float" - }, - "m_innodb_io_r_wait_sum_per_sec": { - "description": "Shows how long (in seconds) it took InnoDB to actually read the data from storage.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 14 }, - "m_innodb_pages_distinct_sum_per_sec": { - "description": "Counts approximately the number of unique pages the query accessed.", + "m_innodb_io_r_bytes_sum_per_sec": { + "description": "Similar to innodb_IO_r_ops, but the unit is bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 15 }, - "m_innodb_queue_wait_sum_per_sec": { - "description": "Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution.", + "m_innodb_io_r_wait_sum_per_sec": { + "description": "Shows how long (in seconds) it took InnoDB to actually read the data from storage.", "type": "number", - "format": "float" + "format": "float", + "x-order": 16 }, "m_innodb_rec_lock_wait_sum_per_sec": { "description": "Shows how long (in seconds) the query waited for row locks.", "type": "number", - "format": "float" + "format": "float", + "x-order": 17 }, - "m_local_blks_dirtied_sum_per_sec": { - "description": "Total number of local blocks dirtied by the statement.", - "type": "number", - "format": "float" - }, - "m_local_blks_hit_sum_per_sec": { - "description": "Total number of local block cache hits by the statement.", + "m_innodb_queue_wait_sum_per_sec": { + "description": "Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution.", "type": "number", - "format": "float" + "format": "float", + "x-order": 18 }, - "m_local_blks_read_sum_per_sec": { - "description": "Total number of local blocks read by the statement.", + "m_innodb_pages_distinct_sum_per_sec": { + "description": "Counts approximately the number of unique pages the query accessed.", "type": "number", - "format": "float" + "format": "float", + "x-order": 19 }, - "m_local_blks_written_sum_per_sec": { - "description": "Total number of local blocks written by the statement.", + "m_query_length_sum_per_sec": { + "description": "Shows how long the query is.", "type": "number", - "format": "float" + "format": "float", + "x-order": 20 }, - "m_lock_time_sum_per_sec": { - "description": "The time to acquire locks in seconds.", + "m_bytes_sent_sum_per_sec": { + "description": "The number of bytes sent to all clients.", "type": "number", - "format": "float" + "format": "float", + "x-order": 21 }, - "m_merge_passes_sum_per_sec": { - "description": "The number of merge passes that the sort algorithm has had to do.", + "m_tmp_tables_sum_per_sec": { + "description": "Number of temporary tables created on memory for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 22 }, - "m_no_good_index_used_sum_per_sec": { - "description": "The number of queries without good index.", + "m_tmp_disk_tables_sum_per_sec": { + "description": "Number of temporary tables created on disk for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 23 }, - "m_no_index_used_sum_per_sec": { - "description": "The number of queries without index.", + "m_tmp_table_sizes_sum_per_sec": { + "description": "Total Size in bytes for all temporary tables used in the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 24 }, "m_qc_hit_sum_per_sec": { "description": "Boolean metrics:\n- *_sum_per_sec - how many times this matric was true.\n\nQuery Cache hits.", "type": "number", - "format": "float" + "format": "float", + "x-order": 25 }, - "m_query_length_sum_per_sec": { - "description": "Shows how long the query is.", - "type": "number", - "format": "float" - }, - "m_query_time_sum_per_sec": { - "description": "The statement execution time in seconds.", + "m_full_scan_sum_per_sec": { + "description": "The query performed a full table scan.", "type": "number", - "format": "float" + "format": "float", + "x-order": 26 }, - "m_response_length_sum_per_sec": { - "description": "The response length of the query result in bytes.", + "m_full_join_sum_per_sec": { + "description": "The query performed a full join (a join without indexes).", "type": "number", - "format": "float" + "format": "float", + "x-order": 27 }, - "m_rows_affected_sum_per_sec": { - "description": "Number of rows changed - UPDATE, DELETE, INSERT.", + "m_tmp_table_sum_per_sec": { + "description": "The query created an implicit internal temporary table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 28 }, - "m_rows_examined_sum_per_sec": { - "description": "Number of rows scanned - SELECT.", + "m_tmp_table_on_disk_sum_per_sec": { + "description": "The querys temporary table was stored on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 29 }, - "m_rows_read_sum_per_sec": { - "description": "The number of rows read from tables.", + "m_filesort_sum_per_sec": { + "description": "The query used a filesort.", "type": "number", - "format": "float" + "format": "float", + "x-order": 30 }, - "m_rows_sent_sum_per_sec": { - "description": "The number of rows sent to the client.", + "m_filesort_on_disk_sum_per_sec": { + "description": "The filesort was performed on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 31 }, "m_select_full_range_join_sum_per_sec": { "description": "The number of joins that used a range search on a reference table.", "type": "number", - "format": "float" - }, - "m_select_range_check_sum_per_sec": { - "description": "The number of joins without keys that check for key usage after each row.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 32 }, "m_select_range_sum_per_sec": { "description": "The number of joins that used ranges on the first table.", "type": "number", - "format": "float" - }, - "m_shared_blks_dirtied_sum_per_sec": { - "description": "Total number of shared blocks dirtied by the statement.", - "type": "number", - "format": "float" - }, - "m_shared_blks_hit_sum_per_sec": { - "description": "PostgreSQL metrics.\n\nTotal number of shared block cache hits by the statement.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 33 }, - "m_shared_blks_read_sum_per_sec": { - "description": "Total number of shared blocks read by the statement.", - "type": "number", - "format": "float" - }, - "m_shared_blks_written_sum_per_sec": { - "description": "Total number of shared blocks written by the statement.", + "m_select_range_check_sum_per_sec": { + "description": "The number of joins without keys that check for key usage after each row.", "type": "number", - "format": "float" + "format": "float", + "x-order": 34 }, "m_sort_range_sum_per_sec": { "description": "The number of sorts that were done using ranges.", "type": "number", - "format": "float" + "format": "float", + "x-order": 35 }, "m_sort_rows_sum_per_sec": { "description": "The number of sorted rows.", "type": "number", - "format": "float" + "format": "float", + "x-order": 36 }, "m_sort_scan_sum_per_sec": { "description": "The number of sorts that were done by scanning the table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 37 }, - "m_temp_blks_read_sum_per_sec": { - "description": "Total number of temp blocks read by the statement.", + "m_no_index_used_sum_per_sec": { + "description": "The number of queries without index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 38 }, - "m_temp_blks_written_sum_per_sec": { - "description": "Total number of temp blocks written by the statement.", + "m_no_good_index_used_sum_per_sec": { + "description": "The number of queries without good index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 39 }, - "m_tmp_disk_tables_sum_per_sec": { - "description": "Number of temporary tables created on disk for the query.", + "m_docs_returned_sum_per_sec": { + "description": "MongoDB metrics.\n\nThe number of returned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 40 }, - "m_tmp_table_on_disk_sum_per_sec": { - "description": "The querys temporary table was stored on disk.", + "m_response_length_sum_per_sec": { + "description": "The response length of the query result in bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 41 }, - "m_tmp_table_sizes_sum_per_sec": { - "description": "Total Size in bytes for all temporary tables used in the query.", + "m_docs_scanned_sum_per_sec": { + "description": "The number of scanned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 42 }, - "m_tmp_table_sum_per_sec": { - "description": "The query created an implicit internal temporary table.", + "m_shared_blks_hit_sum_per_sec": { + "description": "PostgreSQL metrics.\n\nTotal number of shared block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 43 }, - "m_tmp_tables_sum_per_sec": { - "description": "Number of temporary tables created on memory for the query.", + "m_shared_blks_read_sum_per_sec": { + "description": "Total number of shared blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 44 }, - "num_queries_per_sec": { - "description": "number of queries in bucket.", + "m_shared_blks_dirtied_sum_per_sec": { + "description": "Total number of shared blocks dirtied by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 45 }, - "num_queries_with_errors_per_sec": { - "description": "number of queries with errors.", + "m_shared_blks_written_sum_per_sec": { + "description": "Total number of shared blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 46 }, - "num_queries_with_warnings_per_sec": { - "description": "number of queries with warnings.", + "m_local_blks_hit_sum_per_sec": { + "description": "Total number of local block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 47 }, - "point": { - "description": "The serial number of the chart point from the largest time in the time interval to the lowest time in the time range.", - "type": "integer", - "format": "int64" + "m_local_blks_read_sum_per_sec": { + "description": "Total number of local blocks read by the statement.", + "type": "number", + "format": "float", + "x-order": 48 }, - "time_frame": { - "description": "Duration beetween two points.", - "type": "integer", - "format": "int64" + "m_local_blks_dirtied_sum_per_sec": { + "description": "Total number of local blocks dirtied by the statement.", + "type": "number", + "format": "float", + "x-order": 49 }, - "timestamp": { - "description": "Time of point in format RFC3339.", - "type": "string" + "m_local_blks_written_sum_per_sec": { + "description": "Total number of local blocks written by the statement.", + "type": "number", + "format": "float", + "x-order": 50 + }, + "m_temp_blks_read_sum_per_sec": { + "description": "Total number of temp blocks read by the statement.", + "type": "number", + "format": "float", + "x-order": 51 + }, + "m_temp_blks_written_sum_per_sec": { + "description": "Total number of temp blocks written by the statement.", + "type": "number", + "format": "float", + "x-order": 52 + }, + "m_blk_read_time_sum_per_sec": { + "description": "Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "type": "number", + "format": "float", + "x-order": 53 + }, + "m_blk_write_time_sum_per_sec": { + "description": "Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "type": "number", + "format": "float", + "x-order": 54 } } - } + }, + "x-order": 3 + }, + "fingerprint": { + "type": "string", + "x-order": 4 + }, + "num_queries": { + "type": "integer", + "format": "int64", + "x-order": 5 + }, + "qps": { + "type": "number", + "format": "float", + "x-order": 6 + }, + "load": { + "type": "number", + "format": "float", + "x-order": 7 } } - } - }, - "total_rows": { - "type": "integer", - "format": "int64" + }, + "x-order": 3 } } } @@ -634,21 +729,25 @@ "description": "ObjectDetailsLabelsRequest defines filtering of object detail's labels for specific value of\ndimension (ex.: host=hostname1 or queryid=1D410B4BE5060972.", "type": "object", "properties": { + "period_start_from": { + "type": "string", + "format": "date-time", + "x-order": 0 + }, + "period_start_to": { + "type": "string", + "format": "date-time", + "x-order": 1 + }, "filter_by": { "description": "dimension value: ex: queryid - 1D410B4BE5060972.", - "type": "string" + "type": "string", + "x-order": 2 }, "group_by": { "description": "one of dimension: queryid | host ...", - "type": "string" - }, - "period_start_from": { - "type": "string", - "format": "date-time" - }, - "period_start_to": { "type": "string", - "format": "date-time" + "x-order": 3 } } } @@ -671,10 +770,12 @@ "type": "array", "items": { "type": "string" - } + }, + "x-order": 0 } } - } + }, + "x-order": 0 } } } @@ -717,19 +818,25 @@ "description": "MetricsRequest defines filtering of metrics for specific value of dimension (ex.: host=hostname1 or queryid=1D410B4BE5060972.", "type": "object", "properties": { + "period_start_from": { + "type": "string", + "format": "date-time", + "x-order": 0 + }, + "period_start_to": { + "type": "string", + "format": "date-time", + "x-order": 1 + }, "filter_by": { "description": "dimension value: ex: queryid - 1D410B4BE5060972.", - "type": "string" + "type": "string", + "x-order": 2 }, "group_by": { "description": "one of dimension: queryid | host ...", - "type": "string" - }, - "include_only_fields": { - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "x-order": 3 }, "labels": { "type": "array", @@ -738,24 +845,26 @@ "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "x-order": 0 }, "value": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 1 } } - } - }, - "period_start_from": { - "type": "string", - "format": "date-time" + }, + "x-order": 4 }, - "period_start_to": { - "type": "string", - "format": "date-time" + "include_only_fields": { + "type": "array", + "items": { + "type": "string" + }, + "x-order": 5 } } } @@ -774,40 +883,49 @@ "description": "MetricValues is statistics of specific metric.", "type": "object", "properties": { - "avg": { + "rate": { "type": "number", - "format": "float" + "format": "float", + "x-order": 0 }, "cnt": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, - "max": { + "sum": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 }, "min": { "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, - "p99": { + "max": { "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, - "percent_of_total": { + "avg": { "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, - "rate": { + "p99": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, - "sum": { + "percent_of_total": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 } } - } + }, + "x-order": 0 }, "sparkline": { "type": "array", @@ -815,282 +933,338 @@ "description": "Point contains values that represents abscissa (time) and ordinate (volume etc.)\nof every point in a coordinate system of Sparklines.", "type": "object", "properties": { + "point": { + "description": "The serial number of the chart point from the largest time in the time interval to the lowest time in the time range.", + "type": "integer", + "format": "int64", + "x-order": 0 + }, + "time_frame": { + "description": "Duration beetween two points.", + "type": "integer", + "format": "int64", + "x-order": 1 + }, + "timestamp": { + "description": "Time of point in format RFC3339.", + "type": "string", + "x-order": 2 + }, "load": { "description": "load is query_time / time_range.", "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, - "m_blk_read_time_sum_per_sec": { - "description": "Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "num_queries_per_sec": { + "description": "number of queries in bucket.", "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, - "m_blk_write_time_sum_per_sec": { - "description": "Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "num_queries_with_errors_per_sec": { + "description": "number of queries with errors.", "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, - "m_bytes_sent_sum_per_sec": { - "description": "The number of bytes sent to all clients.", + "num_queries_with_warnings_per_sec": { + "description": "number of queries with warnings.", "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, - "m_docs_returned_sum_per_sec": { - "description": "MongoDB metrics.\n\nThe number of returned documents.", + "m_query_time_sum_per_sec": { + "description": "The statement execution time in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 7 }, - "m_docs_scanned_sum_per_sec": { - "description": "The number of scanned documents.", + "m_lock_time_sum_per_sec": { + "description": "The time to acquire locks in seconds.", "type": "number", - "format": "float" + "format": "float", + "x-order": 8 }, - "m_filesort_on_disk_sum_per_sec": { - "description": "The filesort was performed on disk.", + "m_rows_sent_sum_per_sec": { + "description": "The number of rows sent to the client.", "type": "number", - "format": "float" + "format": "float", + "x-order": 9 }, - "m_filesort_sum_per_sec": { - "description": "The query used a filesort.", + "m_rows_examined_sum_per_sec": { + "description": "Number of rows scanned - SELECT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 10 }, - "m_full_join_sum_per_sec": { - "description": "The query performed a full join (a join without indexes).", + "m_rows_affected_sum_per_sec": { + "description": "Number of rows changed - UPDATE, DELETE, INSERT.", "type": "number", - "format": "float" + "format": "float", + "x-order": 11 }, - "m_full_scan_sum_per_sec": { - "description": "The query performed a full table scan.", + "m_rows_read_sum_per_sec": { + "description": "The number of rows read from tables.", "type": "number", - "format": "float" + "format": "float", + "x-order": 12 }, - "m_innodb_io_r_bytes_sum_per_sec": { - "description": "Similar to innodb_IO_r_ops, but the unit is bytes.", + "m_merge_passes_sum_per_sec": { + "description": "The number of merge passes that the sort algorithm has had to do.", "type": "number", - "format": "float" + "format": "float", + "x-order": 13 }, "m_innodb_io_r_ops_sum_per_sec": { "description": "Counts the number of page read operations scheduled.", "type": "number", - "format": "float" - }, - "m_innodb_io_r_wait_sum_per_sec": { - "description": "Shows how long (in seconds) it took InnoDB to actually read the data from storage.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 14 }, - "m_innodb_pages_distinct_sum_per_sec": { - "description": "Counts approximately the number of unique pages the query accessed.", + "m_innodb_io_r_bytes_sum_per_sec": { + "description": "Similar to innodb_IO_r_ops, but the unit is bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 15 }, - "m_innodb_queue_wait_sum_per_sec": { - "description": "Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution.", + "m_innodb_io_r_wait_sum_per_sec": { + "description": "Shows how long (in seconds) it took InnoDB to actually read the data from storage.", "type": "number", - "format": "float" + "format": "float", + "x-order": 16 }, "m_innodb_rec_lock_wait_sum_per_sec": { "description": "Shows how long (in seconds) the query waited for row locks.", "type": "number", - "format": "float" - }, - "m_local_blks_dirtied_sum_per_sec": { - "description": "Total number of local blocks dirtied by the statement.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 17 }, - "m_local_blks_hit_sum_per_sec": { - "description": "Total number of local block cache hits by the statement.", + "m_innodb_queue_wait_sum_per_sec": { + "description": "Shows how long (in seconds) the query spent either waiting to enter the InnoDB queue or inside that queue waiting for execution.", "type": "number", - "format": "float" + "format": "float", + "x-order": 18 }, - "m_local_blks_read_sum_per_sec": { - "description": "Total number of local blocks read by the statement.", + "m_innodb_pages_distinct_sum_per_sec": { + "description": "Counts approximately the number of unique pages the query accessed.", "type": "number", - "format": "float" + "format": "float", + "x-order": 19 }, - "m_local_blks_written_sum_per_sec": { - "description": "Total number of local blocks written by the statement.", + "m_query_length_sum_per_sec": { + "description": "Shows how long the query is.", "type": "number", - "format": "float" + "format": "float", + "x-order": 20 }, - "m_lock_time_sum_per_sec": { - "description": "The time to acquire locks in seconds.", + "m_bytes_sent_sum_per_sec": { + "description": "The number of bytes sent to all clients.", "type": "number", - "format": "float" + "format": "float", + "x-order": 21 }, - "m_merge_passes_sum_per_sec": { - "description": "The number of merge passes that the sort algorithm has had to do.", + "m_tmp_tables_sum_per_sec": { + "description": "Number of temporary tables created on memory for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 22 }, - "m_no_good_index_used_sum_per_sec": { - "description": "The number of queries without good index.", + "m_tmp_disk_tables_sum_per_sec": { + "description": "Number of temporary tables created on disk for the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 23 }, - "m_no_index_used_sum_per_sec": { - "description": "The number of queries without index.", + "m_tmp_table_sizes_sum_per_sec": { + "description": "Total Size in bytes for all temporary tables used in the query.", "type": "number", - "format": "float" + "format": "float", + "x-order": 24 }, "m_qc_hit_sum_per_sec": { "description": "Boolean metrics:\n- *_sum_per_sec - how many times this matric was true.\n\nQuery Cache hits.", "type": "number", - "format": "float" - }, - "m_query_length_sum_per_sec": { - "description": "Shows how long the query is.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 25 }, - "m_query_time_sum_per_sec": { - "description": "The statement execution time in seconds.", + "m_full_scan_sum_per_sec": { + "description": "The query performed a full table scan.", "type": "number", - "format": "float" + "format": "float", + "x-order": 26 }, - "m_response_length_sum_per_sec": { - "description": "The response length of the query result in bytes.", + "m_full_join_sum_per_sec": { + "description": "The query performed a full join (a join without indexes).", "type": "number", - "format": "float" + "format": "float", + "x-order": 27 }, - "m_rows_affected_sum_per_sec": { - "description": "Number of rows changed - UPDATE, DELETE, INSERT.", + "m_tmp_table_sum_per_sec": { + "description": "The query created an implicit internal temporary table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 28 }, - "m_rows_examined_sum_per_sec": { - "description": "Number of rows scanned - SELECT.", + "m_tmp_table_on_disk_sum_per_sec": { + "description": "The querys temporary table was stored on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 29 }, - "m_rows_read_sum_per_sec": { - "description": "The number of rows read from tables.", + "m_filesort_sum_per_sec": { + "description": "The query used a filesort.", "type": "number", - "format": "float" + "format": "float", + "x-order": 30 }, - "m_rows_sent_sum_per_sec": { - "description": "The number of rows sent to the client.", + "m_filesort_on_disk_sum_per_sec": { + "description": "The filesort was performed on disk.", "type": "number", - "format": "float" + "format": "float", + "x-order": 31 }, "m_select_full_range_join_sum_per_sec": { "description": "The number of joins that used a range search on a reference table.", "type": "number", - "format": "float" - }, - "m_select_range_check_sum_per_sec": { - "description": "The number of joins without keys that check for key usage after each row.", - "type": "number", - "format": "float" + "format": "float", + "x-order": 32 }, "m_select_range_sum_per_sec": { "description": "The number of joins that used ranges on the first table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 33 }, - "m_shared_blks_dirtied_sum_per_sec": { - "description": "Total number of shared blocks dirtied by the statement.", - "type": "number", - "format": "float" - }, - "m_shared_blks_hit_sum_per_sec": { - "description": "PostgreSQL metrics.\n\nTotal number of shared block cache hits by the statement.", - "type": "number", - "format": "float" - }, - "m_shared_blks_read_sum_per_sec": { - "description": "Total number of shared blocks read by the statement.", - "type": "number", - "format": "float" - }, - "m_shared_blks_written_sum_per_sec": { - "description": "Total number of shared blocks written by the statement.", + "m_select_range_check_sum_per_sec": { + "description": "The number of joins without keys that check for key usage after each row.", "type": "number", - "format": "float" + "format": "float", + "x-order": 34 }, "m_sort_range_sum_per_sec": { "description": "The number of sorts that were done using ranges.", "type": "number", - "format": "float" + "format": "float", + "x-order": 35 }, "m_sort_rows_sum_per_sec": { "description": "The number of sorted rows.", "type": "number", - "format": "float" + "format": "float", + "x-order": 36 }, "m_sort_scan_sum_per_sec": { "description": "The number of sorts that were done by scanning the table.", "type": "number", - "format": "float" + "format": "float", + "x-order": 37 }, - "m_temp_blks_read_sum_per_sec": { - "description": "Total number of temp blocks read by the statement.", + "m_no_index_used_sum_per_sec": { + "description": "The number of queries without index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 38 }, - "m_temp_blks_written_sum_per_sec": { - "description": "Total number of temp blocks written by the statement.", + "m_no_good_index_used_sum_per_sec": { + "description": "The number of queries without good index.", "type": "number", - "format": "float" + "format": "float", + "x-order": 39 }, - "m_tmp_disk_tables_sum_per_sec": { - "description": "Number of temporary tables created on disk for the query.", + "m_docs_returned_sum_per_sec": { + "description": "MongoDB metrics.\n\nThe number of returned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 40 }, - "m_tmp_table_on_disk_sum_per_sec": { - "description": "The querys temporary table was stored on disk.", + "m_response_length_sum_per_sec": { + "description": "The response length of the query result in bytes.", "type": "number", - "format": "float" + "format": "float", + "x-order": 41 }, - "m_tmp_table_sizes_sum_per_sec": { - "description": "Total Size in bytes for all temporary tables used in the query.", + "m_docs_scanned_sum_per_sec": { + "description": "The number of scanned documents.", "type": "number", - "format": "float" + "format": "float", + "x-order": 42 }, - "m_tmp_table_sum_per_sec": { - "description": "The query created an implicit internal temporary table.", + "m_shared_blks_hit_sum_per_sec": { + "description": "PostgreSQL metrics.\n\nTotal number of shared block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 43 }, - "m_tmp_tables_sum_per_sec": { - "description": "Number of temporary tables created on memory for the query.", + "m_shared_blks_read_sum_per_sec": { + "description": "Total number of shared blocks read by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 44 }, - "num_queries_per_sec": { - "description": "number of queries in bucket.", + "m_shared_blks_dirtied_sum_per_sec": { + "description": "Total number of shared blocks dirtied by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 45 }, - "num_queries_with_errors_per_sec": { - "description": "number of queries with errors.", + "m_shared_blks_written_sum_per_sec": { + "description": "Total number of shared blocks written by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 46 }, - "num_queries_with_warnings_per_sec": { - "description": "number of queries with warnings.", + "m_local_blks_hit_sum_per_sec": { + "description": "Total number of local block cache hits by the statement.", "type": "number", - "format": "float" + "format": "float", + "x-order": 47 }, - "point": { - "description": "The serial number of the chart point from the largest time in the time interval to the lowest time in the time range.", - "type": "integer", - "format": "int64" + "m_local_blks_read_sum_per_sec": { + "description": "Total number of local blocks read by the statement.", + "type": "number", + "format": "float", + "x-order": 48 }, - "time_frame": { - "description": "Duration beetween two points.", - "type": "integer", - "format": "int64" + "m_local_blks_dirtied_sum_per_sec": { + "description": "Total number of local blocks dirtied by the statement.", + "type": "number", + "format": "float", + "x-order": 49 }, - "timestamp": { - "description": "Time of point in format RFC3339.", - "type": "string" + "m_local_blks_written_sum_per_sec": { + "description": "Total number of local blocks written by the statement.", + "type": "number", + "format": "float", + "x-order": 50 + }, + "m_temp_blks_read_sum_per_sec": { + "description": "Total number of temp blocks read by the statement.", + "type": "number", + "format": "float", + "x-order": 51 + }, + "m_temp_blks_written_sum_per_sec": { + "description": "Total number of temp blocks written by the statement.", + "type": "number", + "format": "float", + "x-order": 52 + }, + "m_blk_read_time_sum_per_sec": { + "description": "Total time the statement spent reading blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "type": "number", + "format": "float", + "x-order": 53 + }, + "m_blk_write_time_sum_per_sec": { + "description": "Total time the statement spent writing blocks, in milliseconds (if track_io_timing is enabled, otherwise zero).", + "type": "number", + "format": "float", + "x-order": 54 } } - } + }, + "x-order": 1 }, "totals": { "type": "object", @@ -1098,40 +1272,49 @@ "description": "MetricValues is statistics of specific metric.", "type": "object", "properties": { - "avg": { + "rate": { "type": "number", - "format": "float" + "format": "float", + "x-order": 0 }, "cnt": { "type": "number", - "format": "float" + "format": "float", + "x-order": 1 }, - "max": { + "sum": { "type": "number", - "format": "float" + "format": "float", + "x-order": 2 }, "min": { "type": "number", - "format": "float" + "format": "float", + "x-order": 3 }, - "p99": { + "max": { "type": "number", - "format": "float" + "format": "float", + "x-order": 4 }, - "percent_of_total": { + "avg": { "type": "number", - "format": "float" + "format": "float", + "x-order": 5 }, - "rate": { + "p99": { "type": "number", - "format": "float" + "format": "float", + "x-order": 6 }, - "sum": { + "percent_of_total": { "type": "number", - "format": "float" + "format": "float", + "x-order": 7 } } - } + }, + "x-order": 2 } } } @@ -1174,13 +1357,25 @@ "description": "QueryExampleRequest defines filtering of query examples for specific value of\ndimension (ex.: host=hostname1 or queryid=1D410B4BE5060972.", "type": "object", "properties": { + "period_start_from": { + "type": "string", + "format": "date-time", + "x-order": 0 + }, + "period_start_to": { + "type": "string", + "format": "date-time", + "x-order": 1 + }, "filter_by": { "description": "dimension value: ex: queryid - 1D410B4BE5060972.", - "type": "string" + "type": "string", + "x-order": 2 }, "group_by": { "description": "one of dimension: queryid | host ...", - "type": "string" + "type": "string", + "x-order": 3 }, "labels": { "type": "array", @@ -1189,28 +1384,24 @@ "type": "object", "properties": { "key": { - "type": "string" + "type": "string", + "x-order": 0 }, "value": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 1 } } - } + }, + "x-order": 4 }, "limit": { "type": "integer", - "format": "int64" - }, - "period_start_from": { - "type": "string", - "format": "date-time" - }, - "period_start_to": { - "type": "string", - "format": "date-time" + "format": "int64", + "x-order": 5 } } } @@ -1230,7 +1421,8 @@ "type": "object", "properties": { "example": { - "type": "string" + "type": "string", + "x-order": 0 }, "example_format": { "description": "ExampleFormat is format of query example: real or query without values.", @@ -1242,9 +1434,6 @@ "FINGERPRINT" ] }, - "example_metrics": { - "type": "string" - }, "example_type": { "description": "ExampleType is a type of query example selected for this query class in given period of time.", "type": "string", @@ -1259,25 +1448,35 @@ }, "is_truncated": { "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 }, - "schema": { - "type": "string" + "example_metrics": { + "type": "string", + "x-order": 4 }, "service_id": { - "type": "string" + "type": "string", + "x-order": 5 }, "service_type": { - "type": "string" + "type": "string", + "x-order": 6 + }, + "schema": { + "type": "string", + "x-order": 7 }, "tables": { "type": "array", "items": { "type": "string" - } + }, + "x-order": 8 } } - } + }, + "x-order": 0 } } } @@ -1319,17 +1518,10 @@ "schema": { "type": "object", "properties": { - "data_retention": { - "description": "A number of full days for Prometheus and QAN data retention. Should have a suffix in JSON: 2592000s, 43200m, 720h.", - "type": "string" - }, - "disable_telemetry": { - "type": "boolean", - "format": "boolean" - }, "enable_telemetry": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, "metrics_resolutions": { "description": "MetricsResolutions represents Prometheus exporters metrics resolutions.", @@ -1337,17 +1529,30 @@ "properties": { "hr": { "description": "High resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" - }, - "lr": { - "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 0 }, "mr": { "description": "Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "lr": { + "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", + "type": "string", + "x-order": 2 } } + }, + "disable_telemetry": { + "type": "boolean", + "format": "boolean", + "x-order": 1 + }, + "data_retention": { + "description": "A number of full days for Prometheus and QAN data retention. Should have a suffix in JSON: 2592000s, 43200m, 720h.", + "type": "string", + "x-order": 3 } } } @@ -1363,34 +1568,40 @@ "description": "Settings represents PMM Server settings.", "type": "object", "properties": { - "data_retention": { - "type": "string" - }, "metrics_resolutions": { "description": "MetricsResolutions represents Prometheus exporters metrics resolutions.", "type": "object", "properties": { "hr": { "description": "High resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" - }, - "lr": { - "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 0 }, "mr": { "description": "Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "lr": { + "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", + "type": "string", + "x-order": 2 } } }, - "telemetry_enabled": { + "updates_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, - "updates_disabled": { + "telemetry_enabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 + }, + "data_retention": { + "type": "string", + "x-order": 3 } } } @@ -1446,34 +1657,40 @@ "description": "Settings represents PMM Server settings.", "type": "object", "properties": { - "data_retention": { - "type": "string" - }, "metrics_resolutions": { "description": "MetricsResolutions represents Prometheus exporters metrics resolutions.", "type": "object", "properties": { "hr": { "description": "High resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" - }, - "lr": { - "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 0 }, "mr": { "description": "Medium resolution. Should have a suffix in JSON: 1s, 1m, 1h.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "lr": { + "description": "Low resolution. Should have a suffix in JSON: 1s, 1m, 1h.", + "type": "string", + "x-order": 2 } } }, - "telemetry_enabled": { + "updates_disabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 }, - "updates_disabled": { + "telemetry_enabled": { "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 + }, + "data_retention": { + "type": "string", + "x-order": 3 } } } @@ -1520,7 +1737,8 @@ "force": { "description": "If false, cached information may be returned.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 0 } } } @@ -1536,53 +1754,62 @@ "description": "VersionInfo describes component version, or PMM Server as a whole.", "type": "object", "properties": { + "version": { + "description": "User-visible version.", + "type": "string", + "x-order": 0 + }, "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" - }, - "version": { - "description": "User-visible version.", - "type": "string" + "format": "date-time", + "x-order": 2 } } }, - "last_check": { - "description": "Last check time.", - "type": "string", - "format": "date-time" - }, "latest": { "description": "VersionInfo describes component version, or PMM Server as a whole.", "type": "object", "properties": { + "version": { + "description": "User-visible version.", + "type": "string", + "x-order": 0 + }, "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" - }, - "version": { - "description": "User-visible version.", - "type": "string" + "format": "date-time", + "x-order": 2 } } }, - "latest_news_url": { - "description": "Latest available PMM Server release announcement URL.", - "type": "string" - }, "update_available": { "description": "True if there is a PMM Server update available.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 + }, + "latest_news_url": { + "description": "Latest available PMM Server release announcement URL.", + "type": "string", + "x-order": 3 + }, + "last_check": { + "description": "Last check time.", + "type": "string", + "format": "date-time", + "x-order": 4 } } } @@ -1634,12 +1861,14 @@ "properties": { "auth_token": { "description": "Authentication token for getting update statuses.", - "type": "string" + "type": "string", + "x-order": 0 }, "log_offset": { "description": "Progress log offset.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 } } } @@ -1683,12 +1912,14 @@ "properties": { "auth_token": { "description": "Authentication token.", - "type": "string" + "type": "string", + "x-order": 0 }, "log_offset": { "description": "Progress log offset.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 } } } @@ -1700,22 +1931,25 @@ "schema": { "type": "object", "properties": { - "done": { - "description": "True when update is done.", - "type": "boolean", - "format": "boolean" - }, "log_lines": { "description": "Progress log lines.", "type": "array", "items": { "type": "string" - } + }, + "x-order": 0 }, "log_offset": { "description": "Progress log offset for the next request.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 1 + }, + "done": { + "description": "True when update is done.", + "type": "boolean", + "format": "boolean", + "x-order": 2 } } } @@ -1757,43 +1991,51 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "password": { - "description": "MongoDB password for scraping metrics.", - "type": "string" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "MongoDB username for scraping metrics.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "MongoDB password for scraping metrics.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "MongoDB username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 6 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 7 } } } @@ -1811,32 +2053,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -1851,19 +2069,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -1907,43 +2158,51 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "password": { - "description": "MySQL password for scraping metrics.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "MySQL password for scraping metrics.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 6 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 7 } } } @@ -1961,32 +2220,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2001,19 +2236,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -2057,16 +2325,18 @@ "schema": { "type": "object", "properties": { + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 0 + }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + }, + "x-order": 1 } } } @@ -2084,28 +2354,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2119,6 +2369,31 @@ "STOPPING", "DONE" ] + }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 3 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 5 } } } @@ -2162,16 +2437,18 @@ "schema": { "type": "object", "properties": { + "runs_on_node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 0 + }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "runs_on_node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" + }, + "x-order": 1 } } } @@ -2189,23 +2466,27 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, - "connected": { - "description": "True if Agent is running and connected to pmm-managed.", - "type": "boolean", - "format": "boolean" + "runs_on_node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 1 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, - "runs_on_node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" + "connected": { + "description": "True if Agent is running and connected to pmm-managed.", + "type": "boolean", + "format": "boolean", + "x-order": 3 } } } @@ -2249,43 +2530,51 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "password": { - "description": "PostgreSQL password for scraping metrics.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "PostgreSQL username for scraping metrics.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "PostgreSQL password for scraping metrics.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 6 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 7 } } } @@ -2303,32 +2592,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2343,19 +2608,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -2399,43 +2697,51 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "password": { - "description": "ProxySQL password for scraping metrics.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "ProxySQL password for scraping metrics.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 6 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 7 } } } @@ -2453,32 +2759,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2493,19 +2775,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -2549,43 +2864,51 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "password": { - "description": "MongoDB password for getting profile data.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "MongoDB username for getting profile data.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "MongoDB password for getting profile data.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "MongoDB username for getting profile data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 6 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 7 } } } @@ -2603,27 +2926,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2638,19 +2942,46 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for getting profiler data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for getting profiler data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -2694,48 +3025,57 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disable_query_examples": { - "description": "Disable query examples.", - "type": "boolean", - "format": "boolean" - }, - "password": { - "description": "MySQL password for getting performance data.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "MySQL password for getting performance data.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "disable_query_examples": { + "description": "Disable query examples.", + "type": "boolean", + "format": "boolean", + "x-order": 6 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 8 } } } @@ -2753,32 +3093,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "description": "True if query examples are disabled.", - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2793,19 +3109,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "description": "True if query examples are disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -2849,53 +3198,63 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disable_query_examples": { - "description": "Disable query examples.", - "type": "boolean", - "format": "boolean" - }, - "max_slowlog_file_size": { - "description": "Rotate slowlog file at this size if \u003e 0.\nUse zero or negative value to disable rotation.", - "type": "string", - "format": "int64" - }, - "password": { - "description": "MySQL password for getting slowlog data.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "MySQL username for getting slowlog data.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "MySQL password for getting slowlog data.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "MySQL username for getting slowlog data.", - "type": "string" + "disable_query_examples": { + "description": "Disable query examples.", + "type": "boolean", + "format": "boolean", + "x-order": 6 + }, + "max_slowlog_file_size": { + "description": "Rotate slowlog file at this size if \u003e 0.\nUse zero or negative value to disable rotation.", + "type": "string", + "format": "int64", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 9 } } } @@ -2913,36 +3272,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "max_slowlog_file_size": { - "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -2957,19 +3288,57 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "max_slowlog_file_size": { + "description": "Slowlog file is rotated at this size if \u003e 0.", + "type": "string", + "format": "int64", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } } @@ -3013,43 +3382,51 @@ "schema": { "type": "object", "properties": { - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "password": { - "description": "PostgreSQL password for getting pg stat statements data.", - "type": "string" - }, "pmm_agent_id": { "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 1 }, - "skip_connection_check": { - "description": "Skip connection check.", - "type": "boolean", - "format": "boolean" + "username": { + "description": "PostgreSQL username for getting pg stat statements data.", + "type": "string", + "x-order": 2 + }, + "password": { + "description": "PostgreSQL password for getting pg stat statements data.", + "type": "string", + "x-order": 3 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 4 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, - "username": { - "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 6 + }, + "skip_connection_check": { + "description": "Skip connection check.", + "type": "boolean", + "format": "boolean", + "x-order": 7 } } } @@ -3067,27 +3444,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3102,20 +3460,47 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for getting pg stat statements data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" - } + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + } } } } @@ -3159,33 +3544,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -3205,32 +3595,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3245,19 +3611,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -3302,33 +3701,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -3348,32 +3752,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3388,19 +3768,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -3445,33 +3858,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -3491,28 +3909,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3526,6 +3924,31 @@ "STOPPING", "DONE" ] + }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 3 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 5 } } } @@ -3570,33 +3993,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -3616,32 +4044,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3656,19 +4060,52 @@ "DONE" ] }, - "tls": { - "description": "Use TLS for database connections.", + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, - "tls_skip_verify": { - "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", - "type": "boolean", - "format": "boolean" + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 }, "username": { "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "type": "string", + "x-order": 4 + }, + "tls": { + "description": "Use TLS for database connections.", + "type": "boolean", + "format": "boolean", + "x-order": 5 + }, + "tls_skip_verify": { + "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", + "type": "boolean", + "format": "boolean", + "x-order": 6 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -3713,33 +4150,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -3759,32 +4201,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3799,19 +4217,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } } @@ -3856,33 +4307,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -3902,27 +4358,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -3937,19 +4374,46 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for getting profiler data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for getting profiler data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -3994,33 +4458,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -4040,32 +4509,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "description": "True if query examples are disabled.", - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4080,19 +4525,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "description": "True if query examples are disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -4137,33 +4615,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -4183,36 +4666,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "max_slowlog_file_size": { - "description": "Slowlog file is rotated at this size if \u003e 0.", - "type": "string", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4227,19 +4682,57 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "max_slowlog_file_size": { + "description": "Slowlog file is rotated at this size if \u003e 0.", + "type": "string", + "format": "int64", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } } @@ -4284,33 +4777,38 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "common": { "description": "ChangeCommonAgentParams contains parameters that can be changed for all Agents.", "type": "object", "properties": { - "custom_labels": { - "description": "Replace all custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "enable": { + "description": "Enable this Agent. Can't be used with disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 0 }, "disable": { "description": "Disable this Agent. Can't be used with enabled.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 }, - "enable": { - "description": "Enable this Agent. Can't be used with disabled.", - "type": "boolean", - "format": "boolean" + "custom_labels": { + "description": "Replace all custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 2 }, "remove_custom_labels": { "description": "Remove all custom user-assigned labels.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 } } } @@ -4330,27 +4828,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4365,19 +4844,46 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for getting pg stat statements data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -4423,7 +4929,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -4441,32 +4948,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4481,54 +4964,63 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "MongoDB username for scraping metrics.", - "type": "string" - } - } - }, - "mysqld_exporter": { - "description": "MySQLdExporter runs on Generic or Container Node and exposes MySQL Service metrics.", - "type": "object", - "properties": { - "agent_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "format": "boolean", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" + }, + "x-order": 7 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "format": "int64", + "x-order": 9 + } + } + }, + "mysqld_exporter": { + "description": "MySQLdExporter runs on Generic or Container Node and exposes MySQL Service metrics.", + "type": "object", + "properties": { + "agent_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4543,50 +5035,63 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" - } - } - }, - "node_exporter": { - "description": "NodeExporter runs on Generic or Container Node and exposes its metrics.", - "type": "object", - "properties": { - "agent_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "format": "boolean", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" + }, + "x-order": 7 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "format": "int64", + "x-order": 9 + } + } + }, + "node_exporter": { + "description": "NodeExporter runs on Generic or Container Node and exposes its metrics.", + "type": "object", + "properties": { + "agent_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4600,6 +5105,31 @@ "STOPPING", "DONE" ] + }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 3 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 5 } } }, @@ -4609,23 +5139,27 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, - "connected": { - "description": "True if Agent is running and connected to pmm-managed.", - "type": "boolean", - "format": "boolean" + "runs_on_node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 1 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, - "runs_on_node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" + "connected": { + "description": "True if Agent is running and connected to pmm-managed.", + "type": "boolean", + "format": "boolean", + "x-order": 3 } } }, @@ -4635,32 +5169,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4675,54 +5185,63 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "PostgreSQL username for scraping metrics.", - "type": "string" - } - } - }, - "proxysql_exporter": { - "description": "ProxySQLExporter runs on Generic or Container Node and exposes MySQL Service metrics.", - "type": "object", - "properties": { - "agent_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "format": "boolean", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" + }, + "x-order": 7 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "format": "int64", + "x-order": 9 + } + } + }, + "proxysql_exporter": { + "description": "ProxySQLExporter runs on Generic or Container Node and exposes MySQL Service metrics.", + "type": "object", + "properties": { + "agent_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4737,19 +5256,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } }, @@ -4759,27 +5311,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4794,19 +5327,46 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for getting profiler data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for getting profiler data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } }, @@ -4816,32 +5376,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "description": "True if query examples are disabled.", - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4856,19 +5392,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "description": "True if query examples are disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } }, @@ -4878,36 +5447,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "max_slowlog_file_size": { - "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4922,19 +5463,57 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "max_slowlog_file_size": { + "description": "Slowlog file is rotated at this size if \u003e 0.", + "type": "string", + "format": "int64", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } }, @@ -4944,27 +5523,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -4979,19 +5539,46 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for getting pg stat statements data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -5035,17 +5622,20 @@ "schema": { "type": "object", "properties": { - "node_id": { - "description": "Return only Agents that provide insights for that Node.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", - "type": "string" - }, "pmm_agent_id": { "description": "Return only Agents started by this pmm-agent.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", - "type": "string" + "type": "string", + "x-order": 0 + }, + "node_id": { + "description": "Return only Agents that provide insights for that Node.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", + "type": "string", + "x-order": 1 }, "service_id": { "description": "Return only Agents that provide insights for that Service.\nExactly one of these parameters should be present: pmm_agent_id, node_id, service_id.", - "type": "string" + "type": "string", + "x-order": 2 } } } @@ -5057,40 +5647,50 @@ "schema": { "type": "object", "properties": { - "mongodb_exporter": { + "pmm_agent": { "type": "array", "items": { - "description": "MongoDBExporter runs on Generic or Container Node and exposes MongoDB Service metrics.", + "description": "PMMAgent runs on Generic or Container Node.", "type": "object", "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 + }, + "runs_on_node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 1 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", + "connected": { + "description": "True if Agent is running and connected to pmm-managed.", "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "format": "boolean", + "x-order": 3 + } + } + }, + "x-order": 0 + }, + "node_exporter": { + "type": "array", + "items": { + "description": "NodeExporter runs on Generic or Container Node and exposes its metrics.", + "type": "object", + "properties": { + "agent_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5105,22 +5705,34 @@ "DONE" ] }, - "tls": { - "description": "Use TLS for database connections.", - "type": "boolean", - "format": "boolean" + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 }, - "tls_skip_verify": { - "description": "Skip TLS certificate and hostname validation.", + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 }, - "username": { - "description": "MongoDB username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 3 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 5 } } - } + }, + "x-order": 1 }, "mysqld_exporter": { "type": "array", @@ -5130,32 +5742,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5170,53 +5758,67 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" - } - } - } - }, - "node_exporter": { - "type": "array", - "items": { - "description": "NodeExporter runs on Generic or Container Node and exposes its metrics.", - "type": "object", - "properties": { - "agent_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "format": "boolean", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" + }, + "x-order": 7 }, "listen_port": { "description": "Listen port for scraping metrics.", "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" + "format": "int64", + "x-order": 9 + } + } + }, + "x-order": 2 + }, + "mongodb_exporter": { + "type": "array", + "items": { + "description": "MongoDBExporter runs on Generic or Container Node and exposes MongoDB Service metrics.", + "type": "object", + "properties": { + "agent_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5230,38 +5832,57 @@ "STOPPING", "DONE" ] - } - } - } - }, - "pmm_agent": { - "type": "array", - "items": { - "description": "PMMAgent runs on Generic or Container Node.", - "type": "object", - "properties": { - "agent_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" }, - "connected": { - "description": "True if Agent is running and connected to pmm-managed.", + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for scraping metrics.", + "type": "string", + "x-order": 4 + }, + "tls": { + "description": "Use TLS for database connections.", + "type": "boolean", + "format": "boolean", + "x-order": 5 + }, + "tls_skip_verify": { + "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 }, - "runs_on_node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } - } + }, + "x-order": 3 }, "postgres_exporter": { "type": "array", @@ -5271,32 +5892,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5311,22 +5908,56 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } - } + }, + "x-order": 4 }, "proxysql_exporter": { "type": "array", @@ -5336,32 +5967,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5376,52 +5983,67 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } - } + }, + "x-order": 5 }, - "qan_mongodb_profiler_agent": { + "qan_mysql_perfschema_agent": { "type": "array", "items": { - "description": "QANMongoDBProfilerAgent runs within pmm-agent and sends MongoDB Query Analytics data to the PMM Server.", + "description": "QANMySQLPerfSchemaAgent runs within pmm-agent and sends MySQL Query Analytics data to the PMM Server.", "type": "object", "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5436,57 +6058,67 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for getting profiler data.", - "type": "string" + "query_examples_disabled": { + "description": "True if query examples are disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } - } + }, + "x-order": 6 }, - "qan_mysql_perfschema_agent": { + "qan_mysql_slowlog_agent": { "type": "array", "items": { - "description": "QANMySQLPerfSchemaAgent runs within pmm-agent and sends MySQL Query Analytics data to the PMM Server.", + "description": "QANMySQLSlowlogAgent runs within pmm-agent and sends MySQL Query Analytics data to the PMM Server.", "type": "object", "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "description": "True if query examples are disabled.", - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5501,61 +6133,72 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "max_slowlog_file_size": { + "description": "Slowlog file is rotated at this size if \u003e 0.", + "type": "string", + "format": "int64", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } - } + }, + "x-order": 7 }, - "qan_mysql_slowlog_agent": { + "qan_mongodb_profiler_agent": { "type": "array", "items": { - "description": "QANMySQLSlowlogAgent runs within pmm-agent and sends MySQL Query Analytics data to the PMM Server.", + "description": "QANMongoDBProfilerAgent runs within pmm-agent and sends MongoDB Query Analytics data to the PMM Server.", "type": "object", "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "max_slowlog_file_size": { - "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5570,22 +6213,50 @@ "DONE" ] }, - "tls": { - "description": "Use TLS for database connections.", - "type": "boolean", - "format": "boolean" + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 }, - "tls_skip_verify": { - "description": "Skip TLS certificate and hostname validation.", + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 }, "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "description": "MongoDB username for getting profiler data.", + "type": "string", + "x-order": 4 + }, + "tls": { + "description": "Use TLS for database connections.", + "type": "boolean", + "format": "boolean", + "x-order": 5 + }, + "tls_skip_verify": { + "description": "Skip TLS certificate and hostname validation.", + "type": "boolean", + "format": "boolean", + "x-order": 6 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } - } + }, + "x-order": 8 }, "qan_postgresql_pgstatements_agent": { "type": "array", @@ -5595,27 +6266,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -5630,22 +6282,50 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for getting pg stat statements data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } - } + }, + "x-order": 9 } } } @@ -5688,12 +6368,14 @@ "type": "object", "properties": { "agent_id": { - "type": "string" + "type": "string", + "x-order": 0 }, "force": { "description": "Remove agent with all dependencies.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 1 } } } @@ -5743,44 +6425,53 @@ "schema": { "type": "object", "properties": { + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 0 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 1 }, - "az": { - "description": "Node availability zone.", - "type": "string" + "machine_id": { + "description": "Linux machine-id of the Generic Node where this Container Node runs.", + "type": "string", + "x-order": 2 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 3 }, "container_name": { "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "machine_id": { - "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "type": "string", + "x-order": 4 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 5 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -5796,48 +6487,58 @@ "description": "ContainerNode represents a Docker container.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, - "az": { - "description": "Node availability zone.", - "type": "string" + "machine_id": { + "description": "Linux machine-id of the Generic Node where this Container Node runs.", + "type": "string", + "x-order": 3 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "machine_id": { - "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 6 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } } @@ -5881,40 +6582,48 @@ "schema": { "type": "object", "properties": { + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 0 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" - }, - "az": { - "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 1 }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "machine_id": { + "description": "Linux machine-id.", + "type": "string", + "x-order": 2 }, "distro": { "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 4 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 5 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 6 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -5930,44 +6639,53 @@ "description": "GenericNode represents a bare metal server or virtual machine.", "type": "object", "properties": { - "address": { - "description": "Node address (DNS name or IP).", - "type": "string" - }, - "az": { - "description": "Node availability zone.", - "type": "string" + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" + "address": { + "description": "Node address (DNS name or IP).", + "type": "string", + "x-order": 2 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 4 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 5 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -6011,32 +6729,38 @@ "schema": { "type": "object", "properties": { + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 0 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" - }, - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "type": "string", + "x-order": 1 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 2 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 3 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 4 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 5 } } } @@ -6052,36 +6776,43 @@ "description": "RemoteNode represents generic remote Node. Agents can't run on Remote Nodes.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 3 + }, + "region": { + "description": "Node region.", + "type": "string", + "x-order": 4 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, - "region": { - "description": "Node region.", - "type": "string" + }, + "x-order": 6 } } } @@ -6127,7 +6858,8 @@ "properties": { "node_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -6143,93 +6875,112 @@ "description": "ContainerNode represents a Docker container.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, - "az": { - "description": "Node availability zone.", - "type": "string" + "machine_id": { + "description": "Linux machine-id of the Generic Node where this Container Node runs.", + "type": "string", + "x-order": 3 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "machine_id": { - "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 5 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 6 }, "region": { "description": "Node region.", - "type": "string" - } - } - }, - "generic": { - "description": "GenericNode represents a bare metal server or virtual machine.", - "type": "object", - "properties": { - "address": { - "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 7 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 8 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 + } + } + }, + "generic": { + "description": "GenericNode represents a bare metal server or virtual machine.", + "type": "object", + "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, + "address": { + "description": "Node address (DNS name or IP).", + "type": "string", + "x-order": 2 }, "machine_id": { "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 3 }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 4 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 5 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } }, @@ -6237,36 +6988,43 @@ "description": "RemoteNode represents generic remote Node. Agents can't run on Remote Nodes.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 3 + }, + "region": { + "description": "Node region.", + "type": "string", + "x-order": 4 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, - "region": { - "description": "Node region.", - "type": "string" + }, + "x-order": 6 } } } @@ -6318,105 +7076,126 @@ "schema": { "type": "object", "properties": { - "container": { + "generic": { "type": "array", "items": { - "description": "ContainerNode represents a Docker container.", + "description": "GenericNode represents a bare metal server or virtual machine.", "type": "object", "properties": { - "address": { - "description": "Node address (DNS name or IP).", - "type": "string" - }, - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "container_id": { - "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "container_name": { - "description": "Container name.", - "type": "string" + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "address": { + "description": "Node address (DNS name or IP).", + "type": "string", + "x-order": 2 }, "machine_id": { - "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "description": "Linux machine-id.", + "type": "string", + "x-order": 3 }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 4 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 5 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } - } + }, + "x-order": 0 }, - "generic": { + "container": { "type": "array", "items": { - "description": "GenericNode represents a bare metal server or virtual machine.", + "description": "ContainerNode represents a Docker container.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" - }, - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" + "type": "string", + "x-order": 2 }, "machine_id": { - "description": "Linux machine-id.", - "type": "string" + "description": "Linux machine-id of the Generic Node where this Container Node runs.", + "type": "string", + "x-order": 3 }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "container_id": { + "description": "Container identifier. If specified, must be a unique Docker container identifier.", + "type": "string", + "x-order": 4 + }, + "container_name": { + "description": "Container name.", + "type": "string", + "x-order": 5 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 6 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } - } + }, + "x-order": 1 }, "remote": { "type": "array", @@ -6424,39 +7203,47 @@ "description": "RemoteNode represents generic remote Node. Agents can't run on Remote Nodes.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 3 + }, + "region": { + "description": "Node region.", + "type": "string", + "x-order": 4 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 5 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, - "region": { - "description": "Node region.", - "type": "string" + }, + "x-order": 6 } } - } + }, + "x-order": 2 } } } @@ -6498,14 +7285,16 @@ "schema": { "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, "force": { "description": "Remove node with all dependencies.", "type": "boolean", - "format": "boolean" - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "format": "boolean", + "x-order": 1 } } } @@ -6555,41 +7344,49 @@ "schema": { "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP). Required.", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 0 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "address": { + "description": "Access address (DNS name or IP). Required.", + "type": "string", + "x-order": 2 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 4 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 5 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -6605,45 +7402,54 @@ "description": "MongoDBService represents a generic MongoDB instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -6687,41 +7493,49 @@ "schema": { "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP). Required.", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 0 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "address": { + "description": "Access address (DNS name or IP). Required.", + "type": "string", + "x-order": 2 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 4 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 5 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -6737,45 +7551,54 @@ "description": "MySQLService represents a generic MySQL instance.", "type": "object", "properties": { + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 + }, + "node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 2 + }, "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 + }, + "port": { + "description": "Access port.", + "type": "integer", + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "replication_set": { + "description": "Replication set name.", + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" - }, - "node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" - }, - "port": { - "description": "Access port.", - "type": "integer", - "format": "int64" - }, - "replication_set": { - "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + }, + "x-order": 8 } } } @@ -6819,41 +7642,49 @@ "schema": { "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP). Required.", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 0 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "address": { + "description": "Access address (DNS name or IP). Required.", + "type": "string", + "x-order": 2 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 4 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 5 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -6869,45 +7700,54 @@ "description": "PostgreSQLService represents a generic PostgreSQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -6951,41 +7791,49 @@ "schema": { "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP). Required.", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 0 }, "node_id": { "description": "Node identifier where this instance runs. Required.", - "type": "string" + "type": "string", + "x-order": 1 + }, + "address": { + "description": "Access address (DNS name or IP). Required.", + "type": "string", + "x-order": 2 }, "port": { "description": "Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 3 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 4 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 5 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 6 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } } @@ -7001,45 +7849,54 @@ "description": "ProxySQLService represents a generic ProxySQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -7085,7 +7942,8 @@ "properties": { "service_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -7101,91 +7959,109 @@ "description": "MongoDBService represents a generic MongoDB instance.", "type": "object", "properties": { + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 + }, + "node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 2 + }, "address": { "description": "Access address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 3 + }, + "port": { + "description": "Access port.", + "type": "integer", + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "replication_set": { + "description": "Replication set name.", + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 8 + } + } + }, + "mysql": { + "description": "MySQLService represents a generic MySQL instance.", + "type": "object", + "properties": { + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 }, - "replication_set": { - "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" - } - } - }, - "mysql": { - "description": "MySQLService represents a generic MySQL instance.", - "type": "object", - "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 }, "cluster": { "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 6 + }, + "replication_set": { + "description": "Replication set name.", + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" - }, - "node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" - }, - "port": { - "description": "Access port.", - "type": "integer", - "format": "int64" - }, - "replication_set": { - "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + }, + "x-order": 8 } } }, @@ -7193,45 +8069,54 @@ "description": "PostgreSQLService represents a generic PostgreSQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } }, @@ -7239,45 +8124,54 @@ "description": "ProxySQLService represents a generic ProxySQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -7323,7 +8217,8 @@ "properties": { "node_id": { "description": "Return only Services running on that Node.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -7335,103 +8230,123 @@ "schema": { "type": "object", "properties": { - "mongodb": { + "mysql": { "type": "array", "items": { - "description": "MongoDBService represents a generic MongoDB instance.", + "description": "MySQLService represents a generic MySQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } - } + }, + "x-order": 0 }, - "mysql": { + "mongodb": { "type": "array", "items": { - "description": "MySQLService represents a generic MySQL instance.", + "description": "MongoDBService represents a generic MongoDB instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } - } + }, + "x-order": 1 }, "postgresql": { "type": "array", @@ -7439,48 +8354,58 @@ "description": "PostgreSQLService represents a generic PostgreSQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } - } + }, + "x-order": 2 }, "proxysql": { "type": "array", @@ -7488,48 +8413,58 @@ "description": "ProxySQLService represents a generic ProxySQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } - } + }, + "x-order": 3 } } } @@ -7571,14 +8506,16 @@ "schema": { "type": "object", "properties": { + "service_id": { + "description": "Unique randomly generated instance identifier. Required.", + "type": "string", + "x-order": 0 + }, "force": { "description": "Remove service with all dependencies.", "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Unique randomly generated instance identifier. Required.", - "type": "string" + "format": "boolean", + "x-order": 1 } } } @@ -7630,7 +8567,8 @@ "properties": { "action_id": { "description": "Unique Action ID. Required.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -7682,7 +8620,8 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 } } } @@ -7696,24 +8635,29 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 + }, + "pmm_agent_id": { + "description": "pmm-agent ID where this Action is running / was run.", + "type": "string", + "x-order": 1 + }, + "output": { + "description": "Current Action output; may be partial if Action is still running.", + "type": "string", + "x-order": 2 }, "done": { "description": "True if Action is finished.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 3 }, "error": { "description": "Error message if Action failed.", - "type": "string" - }, - "output": { - "description": "Current Action output; may be partial if Action is still running.", - "type": "string" - }, - "pmm_agent_id": { - "description": "pmm-agent ID where this Action is running / was run.", - "type": "string" + "type": "string", + "x-order": 4 } } } @@ -7755,21 +8699,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if it can't be deduced from the query.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 + }, + "service_id": { + "description": "Service ID for this Action. Required.", + "type": "string", + "x-order": 1 }, "query": { "description": "SQL query. Required.", - "type": "string" + "type": "string", + "x-order": 2 }, - "service_id": { - "description": "Service ID for this Action. Required.", - "type": "string" + "database": { + "description": "Database name. Required if it can't be deduced from the query.", + "type": "string", + "x-order": 3 } } } @@ -7783,11 +8731,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -7829,21 +8779,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if it can't be deduced from the query.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 + }, + "service_id": { + "description": "Service ID for this Action. Required.", + "type": "string", + "x-order": 1 }, "query": { "description": "SQL query. Required.", - "type": "string" + "type": "string", + "x-order": 2 }, - "service_id": { - "description": "Service ID for this Action. Required.", - "type": "string" + "database": { + "description": "Database name. Required if it can't be deduced from the query.", + "type": "string", + "x-order": 3 } } } @@ -7857,11 +8811,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -7903,21 +8859,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if it can't be deduced from the query.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 + }, + "service_id": { + "description": "Service ID for this Action. Required.", + "type": "string", + "x-order": 1 }, "query": { "description": "SQL query. Required.", - "type": "string" + "type": "string", + "x-order": 2 }, - "service_id": { - "description": "Service ID for this Action. Required.", - "type": "string" + "database": { + "description": "Database name. Required if it can't be deduced from the query.", + "type": "string", + "x-order": 3 } } } @@ -7931,11 +8891,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -7977,21 +8939,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if not given in the table_name field.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "database": { + "description": "Database name. Required if not given in the table_name field.", + "type": "string", + "x-order": 3 } } } @@ -8005,11 +8971,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -8051,21 +9019,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if not given in the table_name field.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "database": { + "description": "Database name. Required if not given in the table_name field.", + "type": "string", + "x-order": 3 } } } @@ -8079,11 +9051,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -8125,21 +9099,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if not given in the table_name field.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "database": { + "description": "Database name. Required if not given in the table_name field.", + "type": "string", + "x-order": 3 } } } @@ -8153,11 +9131,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -8199,21 +9179,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if not given in the table_name field.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "database": { + "description": "Database name. Required if not given in the table_name field.", + "type": "string", + "x-order": 3 } } } @@ -8227,11 +9211,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -8273,21 +9259,25 @@ "schema": { "type": "object", "properties": { - "database": { - "description": "Database name. Required if not given in the table_name field.", - "type": "string" - }, "pmm_agent_id": { "description": "pmm-agent ID where to run this Action.", - "type": "string" + "type": "string", + "x-order": 0 }, "service_id": { "description": "Service ID for this Action. Required.", - "type": "string" + "type": "string", + "x-order": 1 }, "table_name": { "description": "Table name. Required. May additionally contain a database name.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "database": { + "description": "Database name. Required if not given in the table_name field.", + "type": "string", + "x-order": 3 } } } @@ -8301,11 +9291,13 @@ "properties": { "action_id": { "description": "Unique Action ID.", - "type": "string" + "type": "string", + "x-order": 0 }, "pmm_agent_id": { "description": "pmm-agent ID where to this Action was started.", - "type": "string" + "type": "string", + "x-order": 1 } } } @@ -8351,41 +9343,6 @@ "description": "AddNodeParams is a params to add new node to inventory while adding new service.", "type": "object", "properties": { - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "container_id": { - "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" - }, - "container_name": { - "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, "node_type": { "description": "NodeType describes supported Node types.", "type": "string", @@ -8397,83 +9354,143 @@ "REMOTE_NODE" ] }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, + "machine_id": { + "description": "Linux machine-id.", + "type": "string", + "x-order": 2 + }, + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 3 + }, + "container_id": { + "description": "Container identifier. If specified, must be a unique Docker container identifier.", + "type": "string", + "x-order": 4 + }, + "container_name": { + "description": "Container name.", + "type": "string", + "x-order": 5 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 6 + }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } }, + "node_id": { + "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", + "type": "string", + "x-order": 1 + }, + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 3 + }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 4 }, - "cluster": { - "description": "Cluster name.", - "type": "string" + "port": { + "description": "Service Access port. Required.", + "type": "integer", + "format": "int64", + "x-order": 5 }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "pmm_agent_id": { + "description": "The \"pmm-agent\" identifier which should run agents. Required.", + "type": "string", + "x-order": 6 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, - "node_id": { - "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 8 }, - "node_name": { - "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "replication_set": { + "description": "Replication set name.", + "type": "string", + "x-order": 9 + }, + "username": { + "description": "MongoDB username for exporter and QAN agent access.", + "type": "string", + "x-order": 10 }, "password": { "description": "MongoDB password for exporter and QAN agent access.", - "type": "string" - }, - "pmm_agent_id": { - "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" - }, - "port": { - "description": "Service Access port. Required.", - "type": "integer", - "format": "int64" + "type": "string", + "x-order": 11 }, "qan_mongodb_profiler": { "description": "If true, adds qan-mongodb-profiler-agent for provided service.", "type": "boolean", - "format": "boolean" - }, - "replication_set": { - "description": "Replication set name.", - "type": "string" + "format": "boolean", + "x-order": 12 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 13 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 14 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "MongoDB username for exporter and QAN agent access.", - "type": "string" + "format": "boolean", + "x-order": 16 } } } @@ -8491,32 +9508,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -8531,19 +9524,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MongoDB username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } }, @@ -8553,27 +9579,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -8588,65 +9595,101 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MongoDB username for getting profiler data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "MongoDB username for getting profiler data.", - "type": "string" - } - } - }, - "service": { - "description": "MongoDBService represents a generic MongoDB instance.", - "type": "object", - "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" + "format": "boolean", + "x-order": 6 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 7 + } + } + }, + "service": { + "description": "MongoDBService represents a generic MongoDB instance.", + "type": "object", + "properties": { + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -8690,45 +9733,15 @@ "schema": { "type": "object", "properties": { + "node_id": { + "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", + "type": "string", + "x-order": 0 + }, "add_node": { "description": "AddNodeParams is a params to add new node to inventory while adding new service.", "type": "object", "properties": { - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "container_id": { - "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" - }, - "container_name": { - "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, "node_type": { "description": "NodeType describes supported Node types.", "type": "string", @@ -8740,98 +9753,156 @@ "REMOTE_NODE" ] }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, + "machine_id": { + "description": "Linux machine-id.", + "type": "string", + "x-order": 2 + }, + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 3 + }, + "container_id": { + "description": "Container identifier. If specified, must be a unique Docker container identifier.", + "type": "string", + "x-order": 4 + }, + "container_name": { + "description": "Container name.", + "type": "string", + "x-order": 5 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 6 + }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } }, + "node_name": { + "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", + "type": "string", + "x-order": 1 + }, + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 3 + }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" + "type": "string", + "x-order": 4 }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "port": { + "description": "Service Access port. Required.", + "type": "integer", + "format": "int64", + "x-order": 5 }, - "disable_query_examples": { - "description": "Disable query examples.", - "type": "boolean", - "format": "boolean" + "pmm_agent_id": { + "description": "The \"pmm-agent\" identifier which should run agents. Required.", + "type": "string", + "x-order": 6 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, - "max_slowlog_file_size": { - "description": "If qan-mysql-slowlog-agent is added, slowlog file is rotated at this size if \u003e 0.\nIf zero, default value 1GB is used. Use negative value to disable rotation.", + "cluster": { + "description": "Cluster name.", "type": "string", - "format": "int64" + "x-order": 8 }, - "node_id": { - "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "replication_set": { + "description": "Replication set name.", + "type": "string", + "x-order": 9 }, - "node_name": { - "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 10 }, "password": { "description": "MySQL password for scraping metrics.", - "type": "string" - }, - "pmm_agent_id": { - "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" - }, - "port": { - "description": "Service Access port. Required.", - "type": "integer", - "format": "int64" + "type": "string", + "x-order": 11 }, "qan_mysql_perfschema": { "description": "If true, adds qan-mysql-perfschema-agent for provided service.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 12 }, "qan_mysql_slowlog": { "description": "If true, adds qan-mysql-slowlog-agent for provided service.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 13 }, - "replication_set": { - "description": "Replication set name.", - "type": "string" - }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 14 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 + }, + "disable_query_examples": { + "description": "Disable query examples.", + "type": "boolean", + "format": "boolean", + "x-order": 16 + }, + "max_slowlog_file_size": { + "description": "If qan-mysql-slowlog-agent is added, slowlog file is rotated at this size if \u003e 0.\nIf zero, default value 1GB is used. Use negative value to disable rotation.", + "type": "string", + "format": "int64", + "x-order": 17 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 18 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" + "format": "boolean", + "x-order": 19 } } } @@ -8849,32 +9920,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -8889,19 +9936,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } }, @@ -8911,32 +9991,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "description": "True if query examples are disabled.", - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -8951,19 +10007,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" + "query_examples_disabled": { + "description": "True if query examples are disabled.", + "type": "boolean", + "format": "boolean", + "x-order": 7 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } }, @@ -8973,36 +10062,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "max_slowlog_file_size": { - "description": "Slowlog file is rotated at this size if \u003e 0.", "type": "string", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "query_examples_disabled": { - "type": "boolean", - "format": "boolean" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -9017,65 +10078,112 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "MySQL username for getting performance data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "MySQL username for getting performance data.", - "type": "string" - } - } - }, - "service": { - "description": "MySQLService represents a generic MySQL instance.", - "type": "object", - "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" + "query_examples_disabled": { + "type": "boolean", + "format": "boolean", + "x-order": 7 }, - "cluster": { - "description": "Cluster name.", - "type": "string" + "max_slowlog_file_size": { + "description": "Slowlog file is rotated at this size if \u003e 0.", + "type": "string", + "format": "int64", + "x-order": 8 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 + } + } + }, + "service": { + "description": "MySQLService represents a generic MySQL instance.", + "type": "object", + "properties": { + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -9119,64 +10227,75 @@ "schema": { "type": "object", "properties": { + "node_type": { + "description": "NodeType describes supported Node types.", + "type": "string", + "default": "NODE_TYPE_INVALID", + "enum": [ + "NODE_TYPE_INVALID", + "GENERIC_NODE", + "CONTAINER_NODE", + "REMOTE_NODE" + ] + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, - "az": { - "description": "Node availability zone.", - "type": "string" + "machine_id": { + "description": "Linux machine-id.", + "type": "string", + "x-order": 3 + }, + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 4 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 5 }, "container_name": { "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" + "type": "string", + "x-order": 6 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, - "node_type": { - "description": "NodeType describes supported Node types.", "type": "string", - "default": "NODE_TYPE_INVALID", - "enum": [ - "NODE_TYPE_INVALID", - "GENERIC_NODE", - "CONTAINER_NODE", - "REMOTE_NODE" - ] + "x-order": 7 }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 8 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 9 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 10 }, "reregister": { "description": "If true, and Node with that name already exist, it will be removed with all dependent Services and Agents.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 11 } } } @@ -9192,93 +10311,112 @@ "description": "ContainerNode represents a Docker container.", "type": "object", "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, "address": { "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 2 }, - "az": { - "description": "Node availability zone.", - "type": "string" + "machine_id": { + "description": "Linux machine-id of the Generic Node where this Container Node runs.", + "type": "string", + "x-order": 3 }, "container_id": { "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" + "type": "string", + "x-order": 4 }, "container_name": { "description": "Container name.", - "type": "string" + "type": "string", + "x-order": 5 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 6 + }, + "region": { + "description": "Node region.", + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 9 + } + } + }, + "generic_node": { + "description": "GenericNode represents a bare metal server or virtual machine.", + "type": "object", + "properties": { + "node_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, + "address": { + "description": "Node address (DNS name or IP).", + "type": "string", + "x-order": 2 }, "machine_id": { - "description": "Linux machine-id of the Generic Node where this Container Node runs.", - "type": "string" + "description": "Linux machine-id.", + "type": "string", + "x-order": 3 }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 4 }, "node_model": { "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" + "type": "string", + "x-order": 5 }, "region": { "description": "Node region.", - "type": "string" - } - } - }, - "generic_node": { - "description": "GenericNode represents a bare metal server or virtual machine.", - "type": "object", - "properties": { - "address": { - "description": "Node address (DNS name or IP).", - "type": "string" + "type": "string", + "x-order": 6 }, "az": { "description": "Node availability zone.", - "type": "string" + "type": "string", + "x-order": 7 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" - }, - "node_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, - "region": { - "description": "Node region.", - "type": "string" + }, + "x-order": 8 } } }, @@ -9288,23 +10426,27 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, - "connected": { - "description": "True if Agent is running and connected to pmm-managed.", - "type": "boolean", - "format": "boolean" + "runs_on_node_id": { + "description": "Node identifier where this instance runs.", + "type": "string", + "x-order": 1 }, "custom_labels": { "description": "Custom user-assigned labels.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "x-order": 2 }, - "runs_on_node_id": { - "description": "Node identifier where this instance runs.", - "type": "string" + "connected": { + "description": "True if Agent is running and connected to pmm-managed.", + "type": "boolean", + "format": "boolean", + "x-order": 3 } } } @@ -9352,41 +10494,6 @@ "description": "AddNodeParams is a params to add new node to inventory while adding new service.", "type": "object", "properties": { - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "container_id": { - "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" - }, - "container_name": { - "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, "node_type": { "description": "NodeType describes supported Node types.", "type": "string", @@ -9398,83 +10505,143 @@ "REMOTE_NODE" ] }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, + "machine_id": { + "description": "Linux machine-id.", + "type": "string", + "x-order": 2 + }, + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 3 + }, + "container_id": { + "description": "Container identifier. If specified, must be a unique Docker container identifier.", + "type": "string", + "x-order": 4 + }, + "container_name": { + "description": "Container name.", + "type": "string", + "x-order": 5 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 6 + }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } }, + "node_id": { + "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", + "type": "string", + "x-order": 0 + }, + "node_name": { + "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", + "type": "string", + "x-order": 1 + }, + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 3 + }, "address": { "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" + "type": "string", + "x-order": 4 }, - "cluster": { - "description": "Cluster name.", - "type": "string" + "port": { + "description": "Service Access port. Required.", + "type": "integer", + "format": "int64", + "x-order": 5 }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "pmm_agent_id": { + "description": "The \"pmm-agent\" identifier which should run agents. Required.", + "type": "string", + "x-order": 6 }, "environment": { "description": "Environment name.", - "type": "string" + "type": "string", + "x-order": 7 }, - "node_id": { - "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 8 }, - "node_name": { - "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "replication_set": { + "description": "Replication set name.", + "type": "string", + "x-order": 9 + }, + "username": { + "description": "PostgreSQL username for scraping metrics.", + "type": "string", + "x-order": 10 }, "password": { "description": "PostgreSQL password for scraping metrics.", - "type": "string" - }, - "pmm_agent_id": { - "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" - }, - "port": { - "description": "Service Access port. Required.", - "type": "integer", - "format": "int64" + "type": "string", + "x-order": 11 }, "qan_postgresql_pgstatements_agent": { "description": "If true, adds qan-postgresql-pgstatements-agent for provided service.", "type": "boolean", - "format": "boolean" - }, - "replication_set": { - "description": "Replication set name.", - "type": "string" + "format": "boolean", + "x-order": 12 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 13 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 14 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 15 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "format": "boolean", + "x-order": 16 } } } @@ -9492,32 +10659,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -9532,19 +10675,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation. Uses sslmode=required instead of verify-full.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } }, @@ -9554,27 +10730,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -9589,19 +10746,46 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "PostgreSQL username for getting pg stat statements data.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "PostgreSQL username for getting pg stat statements data.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 } } }, @@ -9609,45 +10793,54 @@ "description": "PostgreSQLService represents a generic PostgreSQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -9671,65 +10864,30 @@ "type": "string" } } - } - } - } - } - }, - "/v1/management/ProxySQL/Add": { - "post": { - "tags": [ - "ProxySQL" - ], - "summary": "AddProxySQL adds ProxySQL Service and starts several Agents.\nIt automatically adds a service to inventory, which is running on provided \"node_id\",\nthen adds \"proxysql_exporter\" with provided \"pmm_agent_id\" and other parameters.", - "operationId": "AddProxySQL", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "add_node": { - "description": "AddNodeParams is a params to add new node to inventory while adding new service.", - "type": "object", - "properties": { - "az": { - "description": "Node availability zone.", - "type": "string" - }, - "container_id": { - "description": "Container identifier. If specified, must be a unique Docker container identifier.", - "type": "string" - }, - "container_name": { - "description": "Container name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "distro": { - "description": "Linux distribution name and version.", - "type": "string" - }, - "machine_id": { - "description": "Linux machine-id.", - "type": "string" - }, - "node_model": { - "description": "Node model.", - "type": "string" - }, - "node_name": { - "description": "Unique across all Nodes user-defined name.", - "type": "string" - }, + } + } + } + } + }, + "/v1/management/ProxySQL/Add": { + "post": { + "tags": [ + "ProxySQL" + ], + "summary": "AddProxySQL adds ProxySQL Service and starts several Agents.\nIt automatically adds a service to inventory, which is running on provided \"node_id\",\nthen adds \"proxysql_exporter\" with provided \"pmm_agent_id\" and other parameters.", + "operationId": "AddProxySQL", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "add_node": { + "description": "AddNodeParams is a params to add new node to inventory while adding new service.", + "type": "object", + "properties": { "node_type": { "description": "NodeType describes supported Node types.", "type": "string", @@ -9741,77 +10899,136 @@ "REMOTE_NODE" ] }, + "node_name": { + "description": "Unique across all Nodes user-defined name.", + "type": "string", + "x-order": 1 + }, + "machine_id": { + "description": "Linux machine-id.", + "type": "string", + "x-order": 2 + }, + "distro": { + "description": "Linux distribution name and version.", + "type": "string", + "x-order": 3 + }, + "container_id": { + "description": "Container identifier. If specified, must be a unique Docker container identifier.", + "type": "string", + "x-order": 4 + }, + "container_name": { + "description": "Container name.", + "type": "string", + "x-order": 5 + }, + "node_model": { + "description": "Node model.", + "type": "string", + "x-order": 6 + }, "region": { "description": "Node region.", - "type": "string" + "type": "string", + "x-order": 7 + }, + "az": { + "description": "Node availability zone.", + "type": "string", + "x-order": 8 + }, + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 9 } } }, - "address": { - "description": "Node and Service access address (DNS name or IP). Required.", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "environment": { - "description": "Environment name.", - "type": "string" - }, "node_id": { "description": "Node identifier on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 0 }, "node_name": { "description": "Node name on which a service is been running.\nExactly one of these parameters should be present: node_id, node_name, add_node.", - "type": "string" + "type": "string", + "x-order": 1 }, - "password": { - "description": "ProxySQL password for scraping metrics.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name. Required.", + "type": "string", + "x-order": 3 }, - "pmm_agent_id": { - "description": "The \"pmm-agent\" identifier which should run agents. Required.", - "type": "string" + "address": { + "description": "Node and Service access address (DNS name or IP). Required.", + "type": "string", + "x-order": 4 }, "port": { "description": "Service Access port. Required.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 5 + }, + "pmm_agent_id": { + "description": "The \"pmm-agent\" identifier which should run agents. Required.", + "type": "string", + "x-order": 6 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 7 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 8 }, "replication_set": { "description": "Replication set name.", - "type": "string" + "type": "string", + "x-order": 9 }, - "service_name": { - "description": "Unique across all Services user-defined name. Required.", - "type": "string" + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 10 + }, + "password": { + "description": "ProxySQL password for scraping metrics.", + "type": "string", + "x-order": 11 + }, + "custom_labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 12 }, "skip_connection_check": { "description": "Skip connection check.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 13 }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 14 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" - }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "format": "boolean", + "x-order": 15 } } } @@ -9829,32 +11046,8 @@ "properties": { "agent_id": { "description": "Unique randomly generated instance identifier.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "disabled": { - "description": "Desired Agent status: enabled (false) or disabled (true).", - "type": "boolean", - "format": "boolean" - }, - "listen_port": { - "description": "Listen port for scraping metrics.", - "type": "integer", - "format": "int64" - }, - "pmm_agent_id": { - "description": "The pmm-agent identifier which runs this instance.", - "type": "string" - }, - "service_id": { - "description": "Service identifier.", - "type": "string" + "type": "string", + "x-order": 0 }, "status": { "description": "AgentStatus represents actual Agent status.\n\n - STARTING: Agent is starting.\n - RUNNING: Agent is running.\n - WAITING: Agent encountered error and will be restarted automatically soon.\n - STOPPING: Agent is stopping.\n - DONE: Agent finished.", @@ -9869,19 +11062,52 @@ "DONE" ] }, + "pmm_agent_id": { + "description": "The pmm-agent identifier which runs this instance.", + "type": "string", + "x-order": 1 + }, + "disabled": { + "description": "Desired Agent status: enabled (false) or disabled (true).", + "type": "boolean", + "format": "boolean", + "x-order": 2 + }, + "service_id": { + "description": "Service identifier.", + "type": "string", + "x-order": 3 + }, + "username": { + "description": "ProxySQL username for scraping metrics.", + "type": "string", + "x-order": 4 + }, "tls": { "description": "Use TLS for database connections.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 5 }, "tls_skip_verify": { "description": "Skip TLS certificate and hostname validation.", "type": "boolean", - "format": "boolean" + "format": "boolean", + "x-order": 6 }, - "username": { - "description": "ProxySQL username for scraping metrics.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 7 + }, + "listen_port": { + "description": "Listen port for scraping metrics.", + "type": "integer", + "format": "int64", + "x-order": 9 } } }, @@ -9889,45 +11115,54 @@ "description": "ProxySQLService represents a generic ProxySQL instance.", "type": "object", "properties": { - "address": { - "description": "Access address (DNS name or IP).", - "type": "string" - }, - "cluster": { - "description": "Cluster name.", - "type": "string" - }, - "custom_labels": { - "description": "Custom user-assigned labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "service_id": { + "description": "Unique randomly generated instance identifier.", + "type": "string", + "x-order": 0 }, - "environment": { - "description": "Environment name.", - "type": "string" + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 1 }, "node_id": { "description": "Node identifier where this instance runs.", - "type": "string" + "type": "string", + "x-order": 2 + }, + "address": { + "description": "Access address (DNS name or IP).", + "type": "string", + "x-order": 3 }, "port": { "description": "Access port.", "type": "integer", - "format": "int64" + "format": "int64", + "x-order": 4 + }, + "environment": { + "description": "Environment name.", + "type": "string", + "x-order": 5 + }, + "cluster": { + "description": "Cluster name.", + "type": "string", + "x-order": 6 }, "replication_set": { "description": "Replication set name.", - "type": "string" - }, - "service_id": { - "description": "Unique randomly generated instance identifier.", - "type": "string" + "type": "string", + "x-order": 7 }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" + "custom_labels": { + "description": "Custom user-assigned labels.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-order": 8 } } } @@ -9971,14 +11206,6 @@ "schema": { "type": "object", "properties": { - "service_id": { - "description": "Service ID or Service Name is required.\nUnique randomly generated instance identifier.", - "type": "string" - }, - "service_name": { - "description": "Unique across all Services user-defined name.", - "type": "string" - }, "service_type": { "description": "ServiceType describes supported Service types.", "type": "string", @@ -9990,6 +11217,16 @@ "POSTGRESQL_SERVICE", "PROXYSQL_SERVICE" ] + }, + "service_id": { + "description": "Service ID or Service Name is required.\nUnique randomly generated instance identifier.", + "type": "string", + "x-order": 1 + }, + "service_name": { + "description": "Unique across all Services user-defined name.", + "type": "string", + "x-order": 2 } } } @@ -10085,18 +11322,21 @@ "description": "VersionInfo describes component version, or PMM Server as a whole.", "type": "object", "properties": { + "version": { + "description": "User-visible version.", + "type": "string", + "x-order": 0 + }, "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" - }, - "version": { - "description": "User-visible version.", - "type": "string" + "format": "date-time", + "x-order": 2 } } }, @@ -10104,24 +11344,28 @@ "description": "VersionInfo describes component version, or PMM Server as a whole.", "type": "object", "properties": { + "version": { + "description": "User-visible version.", + "type": "string", + "x-order": 0 + }, "full_version": { "description": "Full version for debugging.", - "type": "string" + "type": "string", + "x-order": 1 }, "timestamp": { "description": "Build or release date.", "type": "string", - "format": "date-time" - }, - "version": { - "description": "User-visible version.", - "type": "string" + "format": "date-time", + "x-order": 2 } } }, "version": { "description": "PMM Server version.", - "type": "string" + "type": "string", + "x-order": 0 } } }