Steadybit extension-postman

A Steadybit extension to execute Postman collections via Postman Cloud Api.

Learn about the capabilities of this extension in our Reliability Hub.

Prerequisites

• A Postman account with a valid API Key is needed to execute collections.

Configuration

Postman_Api_Key

Configuration

Environment Variable	Helm value	Meaning	Required	Default
HTTPS_PROXY	via extraEnv variables	Configure the proxy to be used for Postman communication.	no
STEADYBIT_EXTENSION_POSTMAN_API_KEY	postman.apiKey	Configure the api-key to be used for Postman communication.	yes
STEADYBIT_EXTENSION_POSTMAN_API_TIMEOUT	via extraEnv variables	Timeout for a single attempt against the Postman API. Keep it well below the request budget the agent advertises via the Request-Timeout header (28s with agent defaults).	no	8s
STEADYBIT_EXTENSION_POSTMAN_API_MAX_ATTEMPTS	via extraEnv variables	Attempts per Postman API call (first try plus retries). Network errors, 429 (after the delay Postman asks for) and 5xx are retried within the request budget; an exhausted monthly call limit is not.	no	3
STEADYBIT_EXTENSION_POSTMAN_COLLECTION_DISCOVERY_INTERVAL	via extraEnv variables	How often collections are fetched from the Postman API, one call each (30m ≈ 1,440 calls per month).	no	30m
STEADYBIT_EXTENSION_POSTMAN_COLLECTION_DISCOVERY_RETRY_INTERVAL	via extraEnv variables	First delay before a failed collection discovery is retried; it doubles up to the discovery interval. Meanwhile the last discovered collections (at most 24h old) stay available.	no	5m

Beyond the settings above, this extension supports the configuration common to all Steadybit extensions:

• extension-kit — HTTP and health ports, TLS and mutual TLS, unix domain socket, logging, and pprof.
• Target Filtering — stop the extension reporting targets you do not want.
• Group Matching — tag discovered targets with a group, so enrichment rules only match within it.

Installation

Kubernetes

Detailed information about agent and extension installation in kubernetes can also be found in our documentation.

Recommended (via agent helm chart)

All extensions provide a helm chart that is also integrated in the helm-chart of the agent.

You must provide additional values to activate this extension.

--set extension-postman.enabled=true \
--set extension-postman.postman.apiKey={{YOUR_POSTMAN_API_KEY}} \

Additional configuration options can be found in the helm-chart of the extension.

Alternative (via own helm chart)

If you need more control, you can install the extension via its dedicated helm-chart.

helm repo add steadybit-extension-postman https://steadybit.github.io/extension-postman
helm repo update
helm upgrade steadybit-extension-postman \
    --install \
    --wait \
    --timeout 5m0s \
    --create-namespace \
    --namespace steadybit-agent \
    --set postman.apiKey=<YOUR_API_KEY> \
    steadybit-extension-postman/steadybit-extension-postman

Linux Package

This extension is currently not available as a Linux package.

Extension registration

Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to the documentation for more information about extension registration and how to verify.

Proxy

To communicate to Postman via a proxy, we need the environment variable https_proxy to be set. This can be set via helm using the extraEnv variable

--set "extraEnv[0].name=HTTPS_PROXY" \
--set "extraEnv[0].value=https:\\user:pwd@CompanyProxy.com:8888"

Version and Revision

The version and revision of the extension:

• are printed during the startup of the extension
• are added as a Docker label to the image
• are available via the version.txt/revision.txt files in the root of the image