descriptor#

Autogenerated API

argus_api.lib.metrics.v1.descriptor.add_metric_descriptor(domain: str = None, customer: str = None, shortName: str = None, name: str = None, description: str = None, category: str = None, readFunction: str = None, writeFunction: str = None, adminFunction: str = None, keys: dict = None, values: dict = None, timeFrameSize: int = None, timeFrameSizeUnit: str = None, deduplicationFunction: str = None, useSeparateIndex: bool = None, keepBackup: bool = True, keepAuditData: bool = True, globalDescriptor: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Add new metric descriptor. (INTERNAL)

Parameters
  • domain (str) – ID or shortname of domain bound to this metric descriptor. (default Current user domain)

  • customer (str) – ID or shortname of customer bound to this metric descriptor. If not specified, descriptor is domain global

  • shortName (str) – Short name of the metric descriptor. Must be unique per domain. => [a-zA-Z0-9_:\-.]*

  • name (str) – Name of the metric descriptor. Does not need to be unique.

  • description (str) – Description of the metric descriptor. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • category (str) – Category of metric descriptor (default other)

  • readFunction (str) – Function required to fetch metric descriptor and associated records.

  • writeFunction (str) – Function required to submit metric record.

  • adminFunction (str) – Function required to update this metric descriptor.

  • keys (list) – Descriptors for metric keys.

  • values (list) – Descriptors for metric values.

  • timeFrameSize (int) – Time period used for setting up time frames. For each time frame, deduplicationFunction property is used to determine value(s) of metric record.

  • timeFrameSizeUnit (str) – Unit of the timeFrameSize value, this is used as the default resolution unit during aggregation. (default milliseconds)

  • deduplicationFunction (str) – Function used while submitting a metric record, to calculate value if duplicates within same time frame appear. (default none)

  • useSeparateIndex (bool) – Whether the separate index for metric records is used or not. (default false)

  • keepBackup (bool) – Whether to keep a separate record of the metric as a backup outside ElasticSearch. (default true)

  • keepAuditData (bool) – Whether to maintain a record of data useful for auditing. (default true)

  • globalDescriptor (bool) – Whether this descriptor is intended for records that are not customer specific. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.metrics.v1.descriptor.delete_metric_descriptor(descriptor: str, descriptorDomain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Delete metric descriptor (INTERNAL)

Parameters
  • descriptor (str) – Shortname or ID of descriptor

  • descriptorDomain (str) – Domain which is used if short name is specified for ‘descriptor’ parameter. Defaults to current user domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.metrics.v1.descriptor.get_metric_descriptor(descriptor: str, descriptorDomain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Fetch metric descriptor. (PUBLIC)

Parameters
  • descriptor (str) – ID or short name of metric descriptor

  • descriptorDomain (str) – Domain which is used if short name is specified for ‘descriptor’ parameter. Defaults to current user domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.metrics.v1.descriptor.get_metric_descriptors(descriptorDomain: str = None, customer: str = None, keywords: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Fetch metric descriptor based on criteria (PUBLIC)

Parameters
  • descriptorDomain (list) – Restrict search to entries bound to specified domains (domain ID or shortname)

  • customer (list) – Restrict search to entries bound to specified customers (customer ID or shortname)

  • keywords (list) – Search by keywords

  • limit (int) – Maximum number of returned results

  • offset (int) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.metrics.v1.descriptor.search_metric_descriptors(domain: str = None, customer: str = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = None, offset: int = None, includeDeleted: bool = None, limit: int = 25, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Fetch metric descriptor based on criteria (PUBLIC)

Parameters
  • domain (list) – Restrict search to entries bound to specified domains (domain ID or shortname).

  • customer (list) – Restrict search to entries bound to specified customers (customer ID or shortname).

  • keywords (list) – Restrict search to entries containing keywords in description.

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords. (default Match all keywords)

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default All supported fields)

  • includeFlags (list) – Include descriptors which have includeFlags set.

  • excludeFlags (list) – Exclude descriptors which have excludeFlags set.

  • subCriteria (list) – Set additional criterias to be applied as specified in the subcriteria object(s) (AND, AND NOT, OR). (default OR)

  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Include descriptors which have been deleted. (default false)

  • limit (int) – Set this value to set max number of results. (default 25)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.metrics.v1.descriptor.update_metric_descriptor(descriptor: str, descriptorDomain: str = None, shortName: str = None, name: str = None, description: str = None, category: str = None, readFunction: str = None, writeFunction: str = None, adminFunction: str = None, addKeys: dict = None, updateKeys: dict = None, removeKeys: str = None, addValues: dict = None, updateValues: dict = None, removeValues: str = None, timeFrameSize: int = None, timeFrameSizeUnit: str = None, deduplicationFunction: str = None, useSeparateIndex: bool = None, keepBackup: bool = None, keepAuditData: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Update existing metric descriptor. (INTERNAL)

Parameters
  • descriptor (str) – Shortname or ID of descriptor

  • descriptorDomain (str) – Domain which is used if short name is specified for ‘descriptor’ parameter. Defaults to current user domain.

  • shortName (str) – Short name of the metric descriptor. Must be unique per domain. => [a-zA-Z0-9_:\-.]*

  • name (str) – Name of the metric descriptor. Does not need to be unique.

  • description (str) – Description of the metric descriptor. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • category (str) – Category of metric descriptor.

  • readFunction (str) – Function required to fetch metric descriptor and associated records.

  • writeFunction (str) – Function required to submit metric record.

  • adminFunction (str) – Function required to update this metric descriptor.

  • addKeys (list) – Descriptors for metric keys to add. Previously accepted metrics will still exist and considered valid, but new submissions must match the changed descriptor.

  • updateKeys (list) – Descriptors for metric keys to update. Only the translator and language can be updated while name and type are used to identify the key to modify.

  • removeKeys (list) – Descriptors for metric keys to remove. Previously accepted metrics will still exist and considered valid, but new submissions must match the changed descriptor.

  • addValues (list) – Descriptors for metric values to add. Previously accepted metrics will still exist and considered valid, but new submissions must match the changed descriptor.

  • updateValues (list) – Descriptors for metric values to update. Only the default aggregation and value by weight can be updated while the name is used to identify the value to modify.

  • removeValues (list) – Descriptors for metric values to remove. Previously accepted metrics will still exist and considered valid, but new submissions must match the changed descriptor.

  • timeFrameSize (int) – Time period used for setting up time frames. For each time frame, deduplicationFunction property is used to determine value(s) of metric record.

  • timeFrameSizeUnit (str) – Unit of the timeFrameSize value, this is used as the default resolution unit during aggregation. (default milliseconds)

  • deduplicationFunction (str) – Function used while submitting a metric record, to calculate value if duplicates within same time frame appear.

  • useSeparateIndex (bool) – Whether the separate index for metric records is used or not. If value of this property is ‘true’, changing is not permitted.

  • keepBackup (bool) – Whether to keep a separate record of the metric as a backup outside ElasticSearch.

  • keepAuditData (bool) – Whether to maintain a record of data useful for auditing.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON