PutRiemann

Description:

Send events to Riemann (http://riemann.io) when FlowFiles pass through this processor. You can use events to notify Riemann that a FlowFile passed through, or you can attach a more meaningful metric, such as, the time a FlowFile took to get to this processor. All attributes attached to events support the NiFi Expression Language.

Tags:

riemann, monitoring, metrics

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Riemann AddressRiemann AddressHostname of Riemann server
Riemann PortRiemann Port5555Port that Riemann is listening on
Transport ProtocolTransport ProtocolTCP
  • TCP
  • UDP
Transport protocol to speak to Riemann in
TimeoutTimeout1000Timeout in milliseconds when writing events to Riemann
Batch SizeBatch Size100Batch size for incoming FlowFiles
DescriptionDescriptionDescription associated to the event
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
ServiceServiceName of service associated to this event (e.g. FTP File Fetched)
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
StateStateState of service associated to this event in string form (e.g. ok, warning, foo)
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
MetricMetricFloating point number associated to this event
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
TTLTTLFloating point value in seconds until Riemann considers this event as "expired"
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
TagsTagsComma separated list of tags associated to the event
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
HostHost${hostname()}A hostname associated to this event (e.g. nifi-app1)
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
TimeTimeTime of event in unix epoch seconds (long), default: (current time)
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
Custom Event AttributeAny value or expressionThese values will be attached to the Riemann event as a custom attribute
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successMetrics successfully written to Riemann
failureMetrics which failed to write to Riemann

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.