Skip to content

Internal Messages

Internal Messages (`internal-messages`)

Receive internal messages.

Messaging json

Minimal example

input:
  internal-messages: {}

JSON

{
  "input": {
    "internal-messages": {}
  }
}

Contents

Minimal example
Fields
Behavior
Filtering
Schema

Fields

Field	Type	Required	Description
`limit` Behavior	`number` (`integer`)		The number of times to run the input. Examples: `42`, `1.2e-10`
`filter-kind` Filtering	`Filter Kind`		Specifies whether the message originated from the “system” or by the “user”. Allowed values: `system`, `user`, `runtime-artifact-fetch`, `runtime-artifact-fetch-error`, `runtime-artifact-clear`, `runtime-artifact-clear-ack`, `runtime-artifact-fetch-reply`, `runtime-artifact-update`, …
`filter-source` Filtering	`Filter Source[]`		Specifies what process generated the message. Was it a “server”, “worker” or “job”? Allowed values: `job`, `worker`, `server`
`filter-worker` Filtering	`string`		Specifies what worker to select.
`filter-job` Filtering	`string`		Specifies the name of the job that the message came from.
`filter-type` Filtering	`Filter Type[]`		Specifies that particular types of message ought to match. Allowed values: `worker-licensed`, `worker-unlicensed`, `variable`, `variable-deleted`, `begin-shutting-down-job`, `begin-shutting-down-server`, `begin-shutting-down-worker`, `broadcast-job-thread-state`, …
`filter-tag` Filtering	`string`		Specifies that messages matched ought to carry a tag with a particular value. This only matches against user-generated messages.

Behavior

Show fields

Field	Type	Required	Description
`limit`	`number` (`integer`)		The number of times to run the input. Examples: `42`, `1.2e-10`

Filtering

Show fields

Field	Type	Required	Description
`filter-kind`	`Filter Kind`		Specifies whether the message originated from the “system” or by the “user”. Allowed values: `system`, `user`, `runtime-artifact-fetch`, `runtime-artifact-fetch-error`, `runtime-artifact-clear`, `runtime-artifact-clear-ack`, `runtime-artifact-fetch-reply`, `runtime-artifact-update`, …
`filter-source`	`Filter Source[]`		Specifies what process generated the message. Was it a “server”, “worker” or “job”? Allowed values: `job`, `worker`, `server`
`filter-worker`	`string`		Specifies what worker to select.
`filter-job`	`string`		Specifies the name of the job that the message came from.
`filter-type`	`Filter Type[]`		Specifies that particular types of message ought to match. Allowed values: `worker-licensed`, `worker-unlicensed`, `variable`, `variable-deleted`, `begin-shutting-down-job`, `begin-shutting-down-server`, `begin-shutting-down-worker`, `broadcast-job-thread-state`, …
`filter-tag`	`string`		Specifies that messages matched ought to carry a tag with a particular value. This only matches against user-generated messages.

Schema

Filter Kind Options
Filter Source Options
Filter Type Options

Filter Kind Options

Value	Description
`system`	System
`user`	User
`runtime-artifact-fetch`	Runtime Artifact Fetch
`runtime-artifact-fetch-error`	Runtime Artifact Fetch Error
`runtime-artifact-clear`	Runtime Artifact Clear
`runtime-artifact-clear-ack`	Runtime Artifact Clear Ack
`runtime-artifact-fetch-reply`	Runtime Artifact Fetch Reply
`runtime-artifact-update`	Runtime Artifact Update
`runtime-artifact-update-ack`	Runtime Artifact Update Ack

Filter Source Options

Value	Description
`job`	Job
`worker`	Worker
`server`	Server

Filter Type Options

Value	Description
`worker-licensed`	Worker Licensed
`worker-unlicensed`	Worker Unlicensed
`variable`	Variable
`variable-deleted`	Variable Deleted
`begin-shutting-down-job`	Begin Shutting Down Job
`begin-shutting-down-server`	Begin Shutting Down Server
`begin-shutting-down-worker`	Begin Shutting Down Worker
`broadcast-job-thread-state`	Broadcast Job Thread State
`broadcast-server-thread-state`	Broadcast Server Thread State
`broadcast-worker-thread-state`	Broadcast Worker Thread State
`check-job-report-time`	Check Job Report Time
`check-worker-report-time`	Check Worker Report Time
`de-register-job-thread-dependency`	De Register Job Thread Dependency
`de-register-server-thread-dependency`	De Register Server Thread Dependency
`de-register-worker-thread-dependency`	De Register Worker Thread Dependency
`deployed-job-active`	Deployed Job Active
`deployed-job-removed`	Deployed Job Removed
`deployed-job-should-be-running`	Deployed Job Should Be Running
`deployment-phase`	Deployment Phase
`heart-beat`	Heart Beat
`initialise-internal-state`	Initialise Internal State
`initialise-job-states`	Initialise Job States
`job-batch-end`	Job Batch End
`job-backlog-update`	Job Backlog Update
`job-checkpoint-update`	Job Checkpoint Update
`job-deploy-ready`	Job Deploy Ready
`job-deployed`	Job Deployed
`job-document-end`	Job Document End
`job-document-start`	Job Document Start
`job-errors`	Job Errors
`job-execution-anomaly`	Job Execution Anomaly
`job-execution-status`	Job Execution Status
`job-emit-custom`	Job Emit Custom
`job-finished`	Job Finished
`job-idle`	Job Idle
`job-initiated`	Job Initiated
`job-is-processing`	Job Is Processing
`job-logs`	Job Logs
`job-metrics`	Job Metrics
`job-notifications`	Job Notifications
`job-removing`	Job Removing
`job-removed`	Job Removed
`job-remove-failed`	Job Remove Failed
`job-remove-ready`	Job Remove Ready
`job-replaced`	Job Replaced
`job-required`	Job Required
`job-run-ended`	Job Run Ended
`job-runtime-error`	Job Runtime Error
`job-runtime-settings`	Job Runtime Settings
`job-run-started`	Job Run Started
`job-running-docker`	Job Running Docker
`job-running-script`	Job Running Script
`job-running-subprocess`	Job Running Subprocess
`job-running-system-d`	Job Running System D
`job-settings`	Job Settings
`job-step-statistics`	Job Step Statistics
`job-started`	Job Started
`job-staged`	Job Staged
`job-state-transition`	Job State Transition
`job-shutting-down`	Job Shutting Down
`job-stopping`	Job Stopping
`job-stopped`	Job Stopped
`job-timed-out`	Job Timed Out
`job-suspicious-silence`	Job Suspicious Silence
`job-thread-state`	Job Thread State
`job-trace`	Job Trace
`job-trace-requires-samples`	Job Trace Requires Samples
`job-updated`	Job Updated
`job-worker-comms-error`	Job Worker Comms Error
`job-unstaged`	Job Unstaged
`license-state-changed`	License State Changed
`license-validation-failed`	License Validation Failed
`license-validation-ok`	License Validation Ok
`license-volume-violation`	License Volume Violation
`new-license`	New License
`override-job-coordinated-shutdown`	Override Job Coordinated Shutdown
`override-server-coordinated-shutdown`	Override Server Coordinated Shutdown
`override-worker-coordinated-shutdown`	Override Worker Coordinated Shutdown
`register-job-thread-dependency`	Register Job Thread Dependency
`register-server-thread-dependency`	Register Server Thread Dependency
`register-worker-thread-dependency`	Register Worker Thread Dependency
`run-job-failure`	Run Job Failure
`server-logs`	Server Logs
`server-metrics-batch`	Server Metrics Batch
`server-started`	Server Started
`server-starting`	Server Starting
`server-stopping`	Server Stopping
`server-thread-state`	Server Thread State
`server-worker-comms-error`	Server Worker Comms Error
`shutdown-jobs`	Shutdown Jobs
`shutdown-worker`	Shutdown Worker
`system-shutdown`	System Shutdown
`update-upstream-sync-for-job`	Update Upstream Sync For Job
`update-upstream-sync-for-worker`	Update Upstream Sync For Worker
`update-variable`	Update Variable
`user-alert`	User Alert
`user-generated`	User Generated
`user-notification`	User Notification
`worker-command-for-job`	Worker Command For Job
`worker-auth-lease-ack`	Worker Auth Lease Ack
`worker-connected`	Worker Connected
`worker-created`	Worker Created
`worker-debug-heart-beat`	Worker Debug Heart Beat
`worker-error`	Worker Error
`worker-first-seen`	Worker First Seen
`worker-heart-beat`	Worker Heart Beat
`worker-logs`	Worker Logs
`worker-metrics-batch`	Worker Metrics Batch
`worker-offline`	Worker Offline
`worker-requests-auth-lease`	Worker Requests Auth Lease
`worker-server-comms-error`	Worker Server Comms Error
`worker-settings`	Worker Settings
`worker-shutdown`	Worker Shutdown
`worker-shutting-down`	Worker Shutting Down
`worker-started`	Worker Started
`worker-state-uuid`	Worker State Uuid
`worker-stopping`	Worker Stopping
`worker-suspicious-silence`	Worker Suspicious Silence
`worker-system-information`	Worker System Information
`worker-thread-state`	Worker Thread State
`worker-updated`	Worker Updated
`worker-modified`	Worker Modified
`worker-removed`	Worker Removed
`context-changed`	Context Changed
`rerender-deployment`	Rerender Deployment
`job-killed`	Job Killed
`message-serviced`	Message Serviced
`failed-to-service-message`	Failed To Service Message
`worker-wants-initial-settings`	Worker Wants Initial Settings
`worker-wants-initial-settings-reply`	Worker Wants Initial Settings Reply
`worker-wants-deployed-jobs`	Worker Wants Deployed Jobs
`worker-wants-deployed-jobs-reply`	Worker Wants Deployed Jobs Reply
`worker-wants-job-configuration`	Worker Wants Job Configuration
`worker-wants-job-configuration-reply`	Worker Wants Job Configuration Reply
`job-wants-dslir-key`	Job Wants Dslir Key
`job-wants-dslir-key-reply`	Job Wants Dslir Key Reply
`worker-wants-dslir-key`	Worker Wants Dslir Key
`worker-wants-dslir-key-reply`	Worker Wants Dslir Key Reply
`job-wants-variables`	Job Wants Variables
`job-wants-variables-reply`	Job Wants Variables Reply
`job-wants-credentials`	Job Wants Credentials
`job-wants-credentials-reply`	Job Wants Credentials Reply
`job-wants-credentials-error`	Job Wants Credentials Error
`job-wants-secret-variables-reply`	Job Wants Secret Variables Reply
`job-credentials-invalidated`	Job Credentials Invalidated
`aggregator-health`	Aggregator Health
`worker-verification-token`	Worker Verification Token
`worker-requests-verification-token`	Worker Requests Verification Token
`runtime-artifact-update`	Runtime Artifact Update
`runtime-artifact-update-ack`	Runtime Artifact Update Ack
`runtime-artifact-clear`	Runtime Artifact Clear
`runtime-artifact-clear-ack`	Runtime Artifact Clear Ack
`runtime-artifact-fetch`	Runtime Artifact Fetch
`runtime-artifact-fetch-reply`	Runtime Artifact Fetch Reply
`runtime-artifact-fetch-error`	Runtime Artifact Fetch Error