salt.returners.elasticsearch_return¶

Return data to an elasticsearch server for indexing.

maintainer:

Jurnell Cockhren <jurnell.cockhren@sophicware.com>, Arnold Bechtoldt <mail@arnoldbechtoldt.com>

maturity:

New

depends:

elasticsearch-py

platform:

all

To enable this returner the elasticsearch python client must be installed on the desired minions (all or some subset).

Please see documentation of elasticsearch execution module for a valid connection configuration.

To use the returner per salt call:

salt '*' test.ping --return elasticsearch

In order to have the returner apply to all minions:

ext_job_cache: elasticsearch

Minion configuration:

debug_returner_payload': False

Output the payload being posted to the log file in debug mode

doc_type: 'default'

Document type to use for normal return messages

functions_blacklist

Optional list of functions that should not be returned to elasticsearch

index_date: False

Use a dated index (e.g. <index>-2016.11.29)

master_event_index: 'salt-master-event-cache'

Index to use when returning master events

master_event_doc_type: 'efault'

Document type to use got master events

master_job_cache_index: 'salt-master-job-cache'

Index to use for master job cache

master_job_cache_doc_type: 'default'

Document type to use for master job cache

number_of_shards: 1

Number of shards to use for the indexes

number_of_replicas: 0

Number of replicas to use for the indexes

NOTE: The following options are valid for 'state.apply', 'state.sls' and 'state.highstate' functions only.

states_count: False

Count the number of states which succeeded or failed and return it in top-level item called 'counts'. States reporting None (i.e. changes would be made but it ran in test mode) are counted as successes.

states_order_output: False

Prefix the state UID (e.g. file_|-yum_configured_|-/etc/yum.conf_|-managed) with a zero-padded version of the '__run_num__' value to allow for easier sorting. Also store the state function (i.e. file.managed) into a new key '_func'. Change the index to be '<index>-ordered' (e.g. salt-state_apply-ordered).

states_single_index: False

Store results for state.apply, state.sls and state.highstate in the salt-state_apply index (or -ordered/-<date>) indexes if enabled

elasticsearch:
    hosts:
      - "10.10.10.10:9200"
      - "10.10.10.11:9200"
      - "10.10.10.12:9200"
    index_date: True
    number_of_shards: 5
    number_of_replicas: 1
    debug_returner_payload: True
    states_count: True
    states_order_output: True
    states_single_index: True
    functions_blacklist:
      - test.ping
      - saltutil.find_job

salt.returners.elasticsearch_return.event_return(events)¶

Return events to Elasticsearch

Requires that the event_return configuration be set in master config.

salt.returners.elasticsearch_return.get_load(jid)¶

Return the load data that marks a specified jid

New in version 2015.8.1.

salt.returners.elasticsearch_return.prep_jid(nocache=False, passed_jid=None)¶

Do any work necessary to prepare a JID, including sending a custom id

salt.returners.elasticsearch_return.returner(ret)¶

Process the return from Salt

salt.returners.elasticsearch_return.save_load(jid, load, minions=None)¶

Save the load to the specified jid id

New in version 2015.8.1.