Abuse goes here
Atomist API Key used to authenticate the user starting the client.
Application identifier used for metrics send to statsd. If not set, the automation client package name with any namespace prefix removed is used.
Whether and where to send application start and stop events to Atomist.
Whether and how many workers to start up. If enabled is true and workers is false, a number of workers equal to the number of available CPUs will be started.
Automation commands this package provides. If empty or null, the package will be scanned for commands, which must be under a directory named "commands".
Atomist API endpoints
environment automation is running in, e.g., "production" or "testing"
Automation event handlers this package provides. If empty or null, the package will be scanned for event handlers, which must be under a directory named "events".
DO NOT USE. Groups this automation will be registered with. Must be specified if teams is not specified. Cannot be specified if teams is specified. Providing groups indicates this is a global automation, which can only successfully be registered by Atomist.
HTTP configuration, useful for health checks
Custom event ingester
keywords useful for discovery
Log and metric sinks
Logging configuration
Print welcome banner; set to an arbitrary string to display, default is name of automation-client
Add content to the banner which shows up between handlers and footer
Message or Banner to be printed at the top of the banner
Custom log configuration, useful if your logging solution requires host, port, token, etc. configuration.
Log to file; set to file path to overwrite location and name of logfile, defaults to ./log/automation-client.log in current working directory
Log level, default is "info"
Register a custom AutomationMetadataProcessor
Automation name. If not given, the name is extracted from the package.json.
If events should be queued when the registration is not connected to the websocket, specificy "durable". "ephemeral" is suited for testing and running locally and is the default.
Post-processors can be used to modify the configuration after all standard configuration loading has been done and before the client is started. Post-processors return a configuration promise so they can be asynchronous.
Redaction configuration
Redact log messages
Redact messages send via the message client
Register patterns to look for and optional replacements
Register a custom secret resolver
statsd config
statsd client factory to create instances of StatsDClient
Whether to send metrics statsd, default is false
statsd host. If not set, use the host-shots default, "localhost" at the time of this writing.
statsd port. If not set, use the hot-shots default, 8125 at the time of this writing.
Automation version. Must be a valid semantic version, https://semver.org/. If not given, the version is extracted from the package.json.
Atomist workspaces this automation will be registered with. Must be specified if groups is not specified. Cannot be specified if groups is specified.
websocket configuration
Configure backoff behavior on the WS connection
Duration in ms the backend should backoff before sending any more messages
Factor (0 < x <= 1) multiply threshold to get to the lower backoff boundary
Interval in ms to check threshold
Max number of the pending messages in the queue before initiating backoff
compress messages over websocket
Grace period in milliseconds. Note the actual time to shutdown gracefully may be more than twice this, as this period is used to first wait for requests and then used again to wait for any cluster workers to shutdown. If some part of the shutdown hangs, it could take up to ten times this period for all processes to exit.
If true, wait for up to gracePeriod milliseconds to
process in-flight and queued requests.
timeout in milliseconds
Generated using TypeDoc
Configuration that takes SoftwareDeliveryMachineOptions inside the sdm key.