Entities¶

Provides access to ZMON entities.

entities(service_url, infrastructure_account, verify=True, oauth2=False)

Initialize entities wrapper.

Parameters:	service_url (str) – Entities service url. infrastructure_account (str) – Infrastructure account used to filter entities. verify – Verify SSL connection. Default is `True`. oauth2 (bool) – Use OAUTH for authentication. Default is `False`.

Note

If service_url or infrastructure_account were not supplied, their corresponding values in worker plugin config will be used.

Methods of Entities¶

search_local(**kwargs)¶

Search entities in local infrastructure account. If infrastructure_account is not supplied in kwargs, then should search entities “local” to your filtered entities by using the same infrastructure_account as a default filter.

Parameters:	kwargs (str) – Filtering kwargs
Returns:	Entities
Return type:	list

Example searching all instance entities in local account:

entities().search_local(type='instance')

search_all(**kwargs)¶

Search all entities.

Parameters:	kwargs (str) – Filtering kwargs
Returns:	Entities
Return type:	list

alert_coverage(**kwargs)¶

Return alert coverage for infrastructure_account.

Parameters:	kwargs (str) – Filtering kwargs
Returns:	Alert coverage result.
Return type:	list

entities().alert_coverage(type='instance', infrastructure_account='1052643')

[
    {
        'alerts': [],
        'entities': [
            {'id': 'app-1-instance', 'type': 'instance'}
        ]
    }
]