pusher
EXPERIMENTAL
This component is experimental and therefore subject to change or removal outside of major version releases.
Output for publishing messages to Pusher API (https://pusher.com)
Introduced in version 4.3.0.
- Common
- Advanced
# Common config fields, showing default valuesoutput:label: ""pusher:batching:count: 0byte_size: 0period: ""check: ""channel: ""event: ""appId: ""key: ""secret: ""cluster: ""secure: truemax_in_flight: 1
# All config fields, showing default valuesoutput:label: ""pusher:batching:count: 0byte_size: 0period: ""check: ""processors: []channel: ""event: ""appId: ""key: ""secret: ""cluster: ""secure: truemax_in_flight: 1
Fields​
batching
​
maximum batch size is 10 (limit of the pusher library)
Type: object
# Examplesbatching:byte_size: 5000count: 0period: 1sbatching:count: 10period: 1sbatching:check: this.contains("END BATCH")count: 0period: 1m
batching.count
​
A number of messages at which the batch should be flushed. If 0
disables count based batching.
Type: int
Default: 0
batching.byte_size
​
An amount of bytes at which the batch should be flushed. If 0
disables size based batching.
Type: int
Default: 0
batching.period
​
A period in which an incomplete batch should be flushed regardless of its size.
Type: string
Default: ""
# Examplesperiod: 1speriod: 1mperiod: 500ms
batching.check
​
A Bloblang query that should return a boolean value indicating whether a message should end a batch.
Type: string
Default: ""
# Examplescheck: this.type == "end_of_transaction"
batching.processors
​
A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.
Type: array
# Examplesprocessors:- archive:format: concatenateprocessors:- archive:format: linesprocessors:- archive:format: json_array
channel
​
Pusher channel to publish to. Interpolation functions can also be used This field supports interpolation functions.
Type: string
# Exampleschannel: my_channelchannel: ${!json("id")}
event
​
Event to publish to
Type: string
appId
​
Pusher app id
Type: string
key
​
Pusher key
Type: string
secret
​
Pusher secret
Type: string
cluster
​
Pusher cluster
Type: string
secure
​
Enable SSL encryption
Type: bool
Default: true
max_in_flight
​
The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
Type: int
Default: 1