sends SignalFX events
Version added: 0.1.0
The below requirements are needed on the host that executes this module.
- python >= 3.6
- signalfx
- requests
| Parameter |
Choices/Defaults |
Comments |
|
auth_token
string
/ required
|
|
The SignalFX authentication token.
|
|
category
string
|
Choices:
USER_DEFINED ← - ALERT
- AUDIT
- JOB
- COLLECTD
- SERVICE_DISCOVERY
- EXCEPTION
|
A category that describes the event.
|
|
dimensions
dictionary
|
|
Dimensions for the event.
|
|
event_type
string
/ required
|
|
A name for the event.
aliases: name
|
|
properties
dictionary
|
|
Properties for the event.
|
|
realm
string
|
Default:
"us0"
|
The SignalFX realm to use.
|
|
timestamp
integer
|
|
The time at which the event happened (UNIX time).
|
# Send a simple "ExampleTestEvent" event with no metadata
- event:
event_type: ExampleTestEvent
realm: us1
auth_token: "ABCDE12345"
# Send an event with dimenstions attached
- event:
event_type: ExampleTestEvent
dimensions:
application_code: SMPL-001
hostname: "{{ ansible_fqdn }}"
realm: us1
auth_token: "ABCDE12345"Common return values are documented here, the following are the fields unique to this module:
| Key |
Returned |
Description |
|
event
dictionary
|
On success |
A dictionary describing the event sent.
|
| |
category
string
|
On success |
A category that describes the event.
Sample:
USER_DEFINED
|
| |
custom_properties
dictionary
|
When custom properties were set. |
A dictionary representing the custom properties for the event.
Sample:
{'project_name': 'My Project Name'}
|
| |
dimensions
dictionary
|
When dimensions were set. |
A dictionary representing the dimensions for the event.
Sample:
{'project_id': '123456789'}
|
| |
event_type
string
|
On success |
A name for the event.
Sample:
ExampleTestEvent
|
| |
timestamp
integer
|
When a timestamp was explicitly sent. |
The time at which the event happened (UNIX time).
Sample:
1641304973451
|