Generic Service Data Collector Processor

The Generic Service Data Collector processor collects data supplied by a custom service that is not 'lldp', 'bgp' or 'interface'. Service name is specified as 'service_name', service specific key is specified as 'key', 'data_type' to specifies if the collected data is numbers or discrete state values, and 'value_map' for the specific data could be specified as well.

Parameter Description
Input Types No inputs. This is a source processor.
Output Types Discrete-State-Set (DSS), Number-Set (NS), TS (based on data_type)
Data Type

Type of data the service collects: numbers (ns) (such as device temperature), discrete states (dss) (such as device status), text or tables
Graph Query (graph_query)

One or more queries on graph specified as strings, or a list of such queries. (String will be deprecated in a future release.) Multiple queries should provide all the named nodes referenced by the expression fields (including additional_properties). Graph query is executed on the "operation" graph. Results of the queries can be accessed using the "query_result" variable with the appropriate index. For example, if querying property set nodes under name "ps", the result will be available as "query_result[0]["ps"]".

In collector processors (*_collector, if_counter) it is used to choose a set of nodes for further processing (for example, all leaf devices, or all interfaces between leaf and spine devices)

In other processors it is used for general parameterization and it is only supported as a list of queries.

graph_query: "node("system", role="leaf", name="system").
              out("hosted_interfaces").
              node("interface", name="iface").out("link").
              node("link", role="spine_leaf")"
graph_query: ["node("system", role="leaf", name="system")",
              "node("system", role="spine", name="system")"]
Query Expansion For every path, originally returned by graph queries, passed to each generator the latter one produces a set of items and for each item it produces a new path extended by a corresponding property name which value is set of a value of the produced item.
Query Group by (query_group_by)

List (of strings) of node and relationship names used in the graph query to group query results by. Each element in this list represents a named node or relationship matcher in the graph_query field.It is not an expression to be consistent with existing group_by field in grouping processors. Non-expression is simple and more intuitive.

When grouping is active (query_group_by is not null), query results are d by the specified list of names, where one output item is created per each group. In this case, the expressions can only access matcher names specified in query_group_by and the query results for each group are accessed using a new group_items variable. The group_items variable is a list of query results, where each result has named nodes/relationships, not present in query_group_by.

The following list describes the behavior for various values of this field:

  • Value of query_group_by field - Semantics
  • Omitted or provided as json null (ala None in Python) - No grouping is done. This is equivalent to current behavior of extensible_data_collector. Using ‘group_items’ in this case is not permitted and results in probe error state.
  • Empty list ([]) - Produces one group containing all the query results.
  • One or more matcher names - The query results are grouped by the specified nodes or relationships. If this list covers all available matchers in the query, the number of groups is equal to the number of query results.
Query Tag Filter (query_tag_filter) Filters named nodes in the graph queries by assigned tags.
Value Map

A mapping of discrete-state values to human readable strings. A dictionary with all possible Discrete-State-Set states mapped to human-readable representation; applicable for Discrete-State-Set data (that is, when data_type is 'dss') only.

{
    "0": "unknown",
    "1": "down",
    "2": "up",
    "3": "missing"
}
Key (key) Expression mapping from graph query to whatever key is necessary for the service.
Service name (service_name) Name of the custom collector service.
System ID Expression mapping from graph query to a system_id, e.g. "system.system_id" if "system" is a name in the graph query.
Execution count Number of times the data collection is done.
Service input (service_input) Data to pass to telemetry collectors, if any. Can be an expression.
Service interval (service_interval) Telemetry collection interval in seconds. Can be an expression.
Additional Keys Each additional key/value pair is used to extend properties of output stages where value is considered as an expression executed in context of the graph query and its result is used as a property value with respective key. The value of this property is evaluated for each item to associate items with metrics provided by a corresponding collector service. The association is done by keys because each collector reports a set of metrics where each metric is identified by a key in a format that is specific for each collector.

Flow diagram with two components: Generic Service Data Collector in blue and Output in purple, showing data flow between them.
Configuration options:

Configuration interface for Generic Service Data Collector processor, showing fields for graph query, tag filters, system ID, and service name with an interval of 2 minutes.

Related Documentation