diff --git a/agent/docker-compose.yml b/agent/docker-compose.yml index c71ec42e0b..be8d192551 100644 --- a/agent/docker-compose.yml +++ b/agent/docker-compose.yml @@ -12,7 +12,7 @@ services: - PMM_DEBUG=1 - PERCONA_TEST_CHECKS_INTERVAL=10s # for local development - - PMM_ADVISORS_CHECKS_FILE=/srv/checks/custom-checks.yml + - PMM_TEST_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml # for check-dev # - PMM_TEST_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com:443 # - PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX diff --git a/api-tests/docker-compose.yml b/api-tests/docker-compose.yml index 1b7267d327..570ad524c0 100644 --- a/api-tests/docker-compose.yml +++ b/api-tests/docker-compose.yml @@ -12,7 +12,7 @@ services: - PMM_DEBUG=1 - PERCONA_TEST_CHECKS_INTERVAL=10s # for local development - # - PMM_ADVISORS_CHECKS_FILE=/srv/checks/custom-checks.yml + # - PMM_TEST_ADVISOR_CHECKS_FILE=/srv/checks/custom-checks.yml # for check-dev - PMM_TEST_PERCONA_PLATFORM_ADDRESS=check-dev.percona.com - PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY=RWTg+ZmCCjt7O8eWeAmTLAqW+1ozUbpRSKSwNTmO+exlS5KEIPYWuYdX diff --git a/docker-compose.yml b/docker-compose.yml index 3515b955a5..1e2ba1ac33 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -34,7 +34,7 @@ services: # - PMM_CLICKHOUSE_BLOCK_SIZE=10000 # - PMM_CLICKHOUSE_POOL_SIZE=2 # - PMM_DEBUG=1 - # - PMM_ADVISORS_CHECKS_FILE=/srv/checks/local-checks.yml + # - PMM_TEST_ADVISOR_CHECKS_FILE=/srv/checks/local-checks.yml # - PMM_POSTGRES_ADDR=pg # - PMM_POSTGRES_DBNAME=pmm-managed # - PMM_POSTGRES_USERNAME=pmm-managed diff --git a/docs/process/v2_to_v3_environment_variables.md b/docs/process/v2_to_v3_environment_variables.md index 95f4b1c2e8..7bb03d6b71 100644 --- a/docs/process/v2_to_v3_environment_variables.md +++ b/docs/process/v2_to_v3_environment_variables.md @@ -2,49 +2,49 @@ We've renamed some environment variables used by PMM for consistency. Below is a list of affected variables and their new names. -| PMM 2 | PMM 3 | Comments | -|----------------------------------------------|----------------------------------------------|---------------------------------------------------------------| -| `CONTAINER` | `PMM_CONTAINER` | | -| `DATA_RETENTION` | `PMM_DATA_RETENTION` | | -| `DISABLE_ALERTING` | `PMM_DISABLE_ALERTING` | | -| `DISABLE_UPDATES` | `PMM_DISABLE_UPDATES` | | -| `DISABLE_TELEMETRY` | `PMM_DISABLE_TELEMETRY` | | -| `PERCONA_PLATFORM_API_TIMEOUT` | `PMM_PERCONA_PLATFORM_API_TIMEOUT` | | -| `DISABLE_BACKUP_MANAGEMENT` | `PMM_DISABLE_BACKUP_MANAGEMENT` | | -| `ENABLE_AZUREDISCOVER` | `PMM_ENABLE_AZURE_DISCOVER` | | -| `ENABLE_RBAC` | `PMM_ENABLE_RBAC` | | -| `ENABLE_RBAC` | `PMM_ENABLE_RBAC` | | -| `LESS_LOG_NOISE` | `PMM_LESS_LOG_NOISE` | | -| `METRICS_RESOLUTION` | `PMM_METRICS_RESOLUTION` | | -| `METRICS_RESOLUTION_HR` | `PMM_METRICS_RESOLUTION_HR` | | -| `METRICS_RESOLUTION_LR` | `PMM_METRICS_RESOLUTION_LR` | | -| `METRICS_RESOLUTION_MR` | `PMM_METRICS_RESOLUTION_MR` | | -| `PERCONA_TEST_AUTH_HOST` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | -| `PERCONA_TEST_CHECKS_FILE` | `PMM_TEST_ADVISORS_CHECKS_FILE` | | -| `PERCONA_TEST_CHECKS_HOST` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | -| `PERCONA_TEST_CHECKS_PUBLIC_KEY` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY` | -| `PERCONA_TEST_NICER_API` | `PMM_NICER_API` | | -| `PERCONA_TEST_PMM_CLICKHOUSE_ADDR` | `PMM_CLICKHOUSE_ADDR` | | -| `PERCONA_TEST_PMM_CLICKHOUSE_BLOCK_SIZE` | `PMM_CLICKHOUSE_BLOCK_SIZE` | | -| `PERCONA_TEST_PMM_CLICKHOUSE_DATABASE` | `PMM_CLICKHOUSE_DATABASE` | | -| `PERCONA_TEST_PMM_CLICKHOUSE_POOL_SIZE` | `PMM_CLICKHOUSE_POOL_SIZE` | | -| `PERCONA_TEST_PMM_DISABLE_BUILTIN_POSTGRES` | `PMM_DISABLE_BUILTIN_POSTGRES` | | -| `PERCONA_TEST_INTERFACE_TO_BIND` | `PMM_INTERFACE_TO_BIND` | | -| `PERCONA_TEST_PLATFORM_ADDRESS` | `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | | -| `PERCONA_TEST_PLATFORM_INSECURE` | `PMM_TEST_PERCONA_PLATFORM_INSECURE` | | -| `PERCONA_TEST_PLATFORM_PUBLIC_KEY` | `PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY` | | -| `PERCONA_TEST_POSTGRES_ADDR` | `PMM_POSTGRES_ADDR` | | -| `PERCONA_TEST_POSTGRES_DBNAME` | `PMM_POSTGRES_DBNAME` | | -| `PERCONA_TEST_POSTGRES_SSL_CA_PATH` | `PMM_POSTGRES_SSL_CA_PATH` | | -| `PERCONA_TEST_POSTGRES_SSL_CERT_PATH` | `PMM_POSTGRES_SSL_CERT_PATH` | | -| `PERCONA_TEST_POSTGRES_SSL_KEY_PATH` | `PMM_POSTGRES_SSL_KEY_PATH` | | -| `PERCONA_TEST_POSTGRES_SSL_MODE` | `PMM_POSTGRES_SSL_MODE` | | -| `PERCONA_TEST_POSTGRES_DBPASSWORD` | `PMM_POSTGRES_DBPASSWORD` | | -| `PERCONA_TEST_SAAS_HOST` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | -| `PERCONA_TEST_POSTGRES_USERNAME` | `PMM_POSTGRES_USERNAME` | | -| `PERCONA_TEST_STARLARK_ALLOW_RECURSION` | `PMM_TEST_ADVISORS_STARLARK_ALLOW_RECURSION` | | -| `PERCONA_TEST_TELEMETRY_DISABLE_START_DELAY` | `PMM_TEST_TELEMETRY_DISABLE_START_DELAY` | | -| `PERCONA_TEST_TELEMETRY_HOST` | `PMM_TEST_TELEMETRY_HOST` | | -| `PERCONA_TEST_TELEMETRY_INTERVAL` | `PMM_TEST_TELEMETRY_INTERVAL` | | -| `PERCONA_TEST_TELEMETRY_RETRY_BACKOFF` | `PMM_TEST_TELEMETRY_RETRY_BACKOFF` | | -| `PERCONA_TEST_VERSION_SERVICE_URL` | `PMM_TEST_VERSION_SERVICE_URL` | | +| PMM 2 | PMM 3 | Comments | +|----------------------------------------------|---------------------------------------------|---------------------------------------------------------------| +| `CONTAINER` | `PMM_CONTAINER` | | +| `DATA_RETENTION` | `PMM_DATA_RETENTION` | | +| `DISABLE_ALERTING` | `PMM_DISABLE_ALERTING` | | +| `DISABLE_UPDATES` | `PMM_DISABLE_UPDATES` | | +| `DISABLE_TELEMETRY` | `PMM_DISABLE_TELEMETRY` | | +| `PERCONA_PLATFORM_API_TIMEOUT` | `PMM_PERCONA_PLATFORM_API_TIMEOUT` | | +| `DISABLE_BACKUP_MANAGEMENT` | `PMM_DISABLE_BACKUP_MANAGEMENT` | | +| `ENABLE_AZUREDISCOVER` | `PMM_ENABLE_AZURE_DISCOVER` | | +| `ENABLE_RBAC` | `PMM_ENABLE_RBAC` | | +| `ENABLE_RBAC` | `PMM_ENABLE_RBAC` | | +| `LESS_LOG_NOISE` | `PMM_LESS_LOG_NOISE` | | +| `METRICS_RESOLUTION` | `PMM_METRICS_RESOLUTION` | | +| `METRICS_RESOLUTION_HR` | `PMM_METRICS_RESOLUTION_HR` | | +| `METRICS_RESOLUTION_LR` | `PMM_METRICS_RESOLUTION_LR` | | +| `METRICS_RESOLUTION_MR` | `PMM_METRICS_RESOLUTION_MR` | | +| `PERCONA_TEST_AUTH_HOST` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_CHECKS_FILE` | `PMM_TEST_ADVISOR_CHECKS_FILE` | | +| `PERCONA_TEST_CHECKS_HOST` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_CHECKS_PUBLIC_KEY` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY` | +| `PERCONA_TEST_NICER_API` | `PMM_NICER_API` | | +| `PERCONA_TEST_PMM_CLICKHOUSE_ADDR` | `PMM_CLICKHOUSE_ADDR` | | +| `PERCONA_TEST_PMM_CLICKHOUSE_BLOCK_SIZE` | `PMM_CLICKHOUSE_BLOCK_SIZE` | | +| `PERCONA_TEST_PMM_CLICKHOUSE_DATABASE` | `PMM_CLICKHOUSE_DATABASE` | | +| `PERCONA_TEST_PMM_CLICKHOUSE_POOL_SIZE` | `PMM_CLICKHOUSE_POOL_SIZE` | | +| `PERCONA_TEST_PMM_DISABLE_BUILTIN_POSTGRES` | `PMM_DISABLE_BUILTIN_POSTGRES` | | +| `PERCONA_TEST_INTERFACE_TO_BIND` | `PMM_INTERFACE_TO_BIND` | | +| `PERCONA_TEST_PLATFORM_ADDRESS` | `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | | +| `PERCONA_TEST_PLATFORM_INSECURE` | `PMM_TEST_PERCONA_PLATFORM_INSECURE` | | +| `PERCONA_TEST_PLATFORM_PUBLIC_KEY` | `PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY` | | +| `PERCONA_TEST_POSTGRES_ADDR` | `PMM_POSTGRES_ADDR` | | +| `PERCONA_TEST_POSTGRES_DBNAME` | `PMM_POSTGRES_DBNAME` | | +| `PERCONA_TEST_POSTGRES_SSL_CA_PATH` | `PMM_POSTGRES_SSL_CA_PATH` | | +| `PERCONA_TEST_POSTGRES_SSL_CERT_PATH` | `PMM_POSTGRES_SSL_CERT_PATH` | | +| `PERCONA_TEST_POSTGRES_SSL_KEY_PATH` | `PMM_POSTGRES_SSL_KEY_PATH` | | +| `PERCONA_TEST_POSTGRES_SSL_MODE` | `PMM_POSTGRES_SSL_MODE` | | +| `PERCONA_TEST_POSTGRES_DBPASSWORD` | `PMM_POSTGRES_DBPASSWORD` | | +| `PERCONA_TEST_SAAS_HOST` | | Removed in PMM v3, use `PMM_TEST_PERCONA_PLATFORM_ADDRESS` | +| `PERCONA_TEST_POSTGRES_USERNAME` | `PMM_POSTGRES_USERNAME` | | +| `PERCONA_TEST_STARLARK_ALLOW_RECURSION` | `PMM_TEST_ADVISOR_STARLARK_ALLOW_RECURSION` | | +| `PERCONA_TEST_TELEMETRY_DISABLE_START_DELAY` | `PMM_TEST_TELEMETRY_DISABLE_START_DELAY` | | +| `PERCONA_TEST_TELEMETRY_HOST` | `PMM_TEST_TELEMETRY_HOST` | | +| `PERCONA_TEST_TELEMETRY_INTERVAL` | `PMM_TEST_TELEMETRY_INTERVAL` | | +| `PERCONA_TEST_TELEMETRY_RETRY_BACKOFF` | `PMM_TEST_TELEMETRY_RETRY_BACKOFF` | | +| `PERCONA_TEST_VERSION_SERVICE_URL` | `PMM_TEST_VERSION_SERVICE_URL` | | diff --git a/managed/CONTRIBUTING.md b/managed/CONTRIBUTING.md index a52fe63ccb..5d15042228 100644 --- a/managed/CONTRIBUTING.md +++ b/managed/CONTRIBUTING.md @@ -54,24 +54,24 @@ go test -timeout=30s -p 1 ./... ## Available test environment variables: | Variable | Description | Default | -|-----------------------------------------| ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------| | PMM_CLICKHOUSE_ADDR | Sets Clickhouse address | 127.0.0.1:9000 | | PMM_CLICKHOUSE_DATABASE | Sets Clickhouse database | pmm | | PMM_CLICKHOUSE_POOL_SIZE | Sets Clickhouse connections pool size | none | | PMM_CLICKHOUSE_BLOCK_SIZE | Sets Clickhouse block size | none | | PMM_ADVISORS_STARLARK_ALLOW_RECURSION | Allows recursive functions in checks scripts | false | -| PMM_NICER_API | Enables nicer API with default/zero values in response. | false | -| PMM_TEST_VERSION_SERVICE_URL | Sets versions service URL | https://check.percona.com/versions/v1 | -| PMM_ADVISORS_CHECKS_FILE | Specifies path to local checks file and disables downlading checks files from Percona Platform | none | +| PMM_NICER_API | Enables nicer API with default/zero values in response. | false | +| PMM_TEST_VERSION_SERVICE_URL | Sets versions service URL | https://check.percona.com/versions/v1 | +| PMM_TEST_ADVISOR_CHECKS_FILE | Specifies path to local checks file and disables downlading checks files from Percona Platform | none | | PMM_ADVISORS_CHECKS_DISABLE_START_DELAY | Disables checks service startup delay | false | | PMM_TEST_TELEMETRY_INTERVAL | Sets telemetry reporting interval | 24h | -| PMM_TEST_TELEMETRY_DISABLE_SEND | Disables sending of telemetry data to SaaS. This param doesn't affect telemetry data gathering from the datasources | false | -| PMM_TEST_TELEMETRY_FILE | Sets path for telemetry config file | | +| PMM_TEST_TELEMETRY_DISABLE_SEND | Disables sending of telemetry data to SaaS. This param doesn't affect telemetry data gathering from the datasources | false | +| PMM_TEST_TELEMETRY_FILE | Sets path for telemetry config file | | | PMM_TEST_TELEMETRY_DISABLE_START_DELAY | Disable the default telemetry execution start delay, so that telemetry gathering is run immediately upon system | false | | PMM_TEST_TELEMETRY_RETRY_BACKOFF | Sets telemetry reporting retry backoff time | 1h | -| PMM_TEST_PERCONA_PLATFORM_ADDRESS | Sets Percona Platform address | https://check.percona.com | -| PMM_TEST_PERCONA_PLATFORM_INSECURE | Allows insecure TLS connections to Percona Platform | false | -| PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY | Sets Percona Platform public key (Minisign) | set of keys embedded into managed binary | +| PMM_TEST_PERCONA_PLATFORM_ADDRESS | Sets Percona Platform address | https://check.percona.com | +| PMM_TEST_PERCONA_PLATFORM_INSECURE | Allows insecure TLS connections to Percona Platform | false | +| PMM_TEST_PERCONA_PLATFORM_PUBLIC_KEY | Sets Percona Platform public key (Minisign) | set of keys embedded into managed binary | ## Add instances for monitoring diff --git a/managed/cmd/pmm-managed-starlark/main.go b/managed/cmd/pmm-managed-starlark/main.go index de62ab8a24..5fb3e73a85 100644 --- a/managed/cmd/pmm-managed-starlark/main.go +++ b/managed/cmd/pmm-managed-starlark/main.go @@ -42,7 +42,7 @@ const ( memoryLimitBytes = 1024 * 1024 * 1024 // Only used for testing. - starlarkRecursionFlag = "PMM_ADVISORS_STARLARK_ALLOW_RECURSION" + starlarkRecursionFlag = "PMM_TEST_ADVISOR_STARLARK_ALLOW_RECURSION" // Warning messages. cpuUsageWarning = "Failed to limit CPU usage" diff --git a/managed/services/checks/checks.go b/managed/services/checks/checks.go index f09a8b2b02..39344231a2 100644 --- a/managed/services/checks/checks.go +++ b/managed/services/checks/checks.go @@ -56,7 +56,7 @@ const ( defaultStartDelay = time.Minute // Environment variables that affect checks service; only for testing. - envCheckFile = "PMM_ADVISORS_CHECKS_FILE" + envCheckFile = "PMM_TEST_ADVISOR_CHECKS_FILE" envDisableStartDelay = "PMM_ADVISORS_CHECKS_DISABLE_START_DELAY" checkExecutionTimeout = 5 * time.Minute // limits execution time for every single check