OpenSearch/docs/en/rest-api/ml/jobcounts.asciidoc

//lcawley Verified example output 2017-04-11
[[ml-jobstats]]
==== Job Stats

The get job statistics API provides information about the operational
progress of a job.

`assignment_explanation`::
  (string) For open jobs only, contains messages relating to the selection of an executing node.

`data_counts`::
  (object) An object that describes the number of records processed and any related error counts.
  See <<ml-datacounts,data counts objects>>.

`job_id`::
  (string) A numerical character string that uniquely identifies the job.

`model_size_stats`::
  (object) An object that provides information about the size and contents of the model.
  See <<ml-modelsizestats,model size stats objects>>

`node`::
  (object) For open jobs only, contains information about the executing node.
  See <<ml-stats-node,node object>>.

`open_time`::
  (string) For open jobs only, the elapsed time for which the job has been open.
  E.g. `28746386s`.

`state`::
  (string) The status of the job, which can be one of the following values:

  `open`::: The job is available to receive and process data.
  `closed`::: The job finished successfully with its model state persisted.
  The job must be opened before it can accept further data.
  `closing`::: The job close action is in progress and has not yet completed.
  A closing job cannot accept further data.
  `failed`::: The job did not finish successfully due to an error.
  This situation can occur due to invalid input data. 
  If the job had irrevecobly failed, it must be force closed and then deleted.
  If the datafeed can be corrected, the job can be closed and then re-opened.

[float]
[[ml-datacounts]]
===== Data Counts Objects

The `data_counts` object describes the number of records processed
and any related error counts. 

The `data_count` values are cumulative for the lifetime of a job. If a model snapshot is reverted
or old results are deleted, the job counts are not reset.

`bucket_count`::
  (long) The number of bucket results produced by the job.

`earliest_record_timestamp`::
  (string) The timestamp of the earliest chronologically ordered record.
  The datetime string is in ISO 8601 format.

`empty_bucket_count`::
  (long) The number of buckets which did not contain any data. If your data contains many 
  empty buckets, consider increasing your `bucket_span` or using functions that are tolerant  
  to gaps in data such as `mean`, `non_null_sum` or `non_zero_count`.

`input_bytes`::
  (long) The number of raw bytes read by the job.

`input_field_count`::
  (long) The total number of record fields read by the job. This count includes
  fields that are not used in the analysis.

`input_record_count`::
  (long) The number of data records read by the job.

`invalid_date_count`::
  (long) The number of records with either a missing date field or a date that could not be parsed.

`job_id`::
  (string) A numerical character string that uniquely identifies the job.

`last_data_time`::
  (datetime) The timestamp at which data was last analyzed, according to server time. 

`latest_empty_bucket_timestamp`::
  (date) The timestamp of the last bucket that did not contain any data.

`latest_record_timestamp`::
  (date) The timestamp of the last processed record.

`latest_sparse_bucket_timestamp`::
  (date) The timestamp of the last bucket that was considered sparse.

`missing_field_count`::
  (long) The number of records that are missing a field that the job is configured to analyze.
  Records with missing fields are still processed because it is possible that not all fields are missing.
  The value of `processed_record_count` includes this count. +
+
--
NOTE: If you are using data feeds or posting data to the job in JSON format, a
high `missing_field_count` is often not an indication of data issues. It is not
necessarily a cause for concern.

--

`out_of_order_timestamp_count`::
  (long) The number of records that are out of time sequence and outside of the latency window.
  This is only applicable when using the `_data` endpoint.
  These records are discarded, since jobs require time series data to be in ascending chronological order.

`processed_field_count`::
  (long) The total number of fields in all the records that have been processed by the job.
  Only fields that are specified in the detector configuration object contribute to this count.
  The time stamp is not included in this count.

`processed_record_count`::
  (long) The number of records that have been processed by the job.
  This value includes records with missing fields, since they are nonetheless analyzed.
  +
  When using datafeeds, the `processed_record_count` will differ from the `input_record_count`
  if you are using aggregations in your search query.
  +
  When posting to the `/_data` endpoint, the following records are not processed:
  * Records not in chronological order and outside the latency window
  * Records with invalid timestamp

`sparse_bucket_count`::
  (long) The number of buckets which contained few data points compared to the expected number
  of data points. If your data contains many sparse buckets, consider using a longer `bucket_span`.

[float]
[[ml-modelsizestats]]
===== Model Size Stats Objects

The `model_size_stats` object has the following properties:

`bucket_allocation_failures_count`::
  (long) The number of buckets for which new entites in incoming data was not processed due to a 
  insufficient model memory as signified by a `hard_limit` `memory_status`.  

`job_id`::
  (string) A numerical character string that uniquely identifies the job.

`log_time`::
  (date) The timestamp of the `model_size_stats` according to server time.

`memory_status`::
  (string) The status of the mathematical models. This property can have one of the following values:
  `ok`::: The models stayed below the configured value.
  `soft_limit`::: The models used more than 60% of the configured memory limit and older unused models will be pruned to free up space.
  `hard_limit`::: The models used more space than the configured memory limit. As a result, not all incoming data was processed.

`model_bytes`::
  (long) The number of bytes of memory used by the models. This is the maximum value since the
  last time the model was persisted. If the job is closed, this value indicates the latest size.

`result_type`::
  (string) For internal use. The type of result.

`total_by_field_count`::
  (long) The number of `by` field values that were analyzed by the models.
+
--
NOTE: The `by` field values are counted separately for each detector and partition.
--

`total_over_field_count`::
  (long) The number of `over` field values that were analyzed by the models.
+
--
NOTE: The `over` field values are counted separately for each detector and partition.
--

`total_partition_field_count`::
  (long) The number of `partition` field values that were analyzed by the models.

`timestamp`::
  (date) The timestamp of the `model_size_stats` according to the timestamp of the data.

[float]
[[ml-stats-node]]
===== Node Objects

The `node` objects contains properties of the executing node and is only available for open jobs.

`id`::
  (string) The unique identifier of the executing node. 

`name`::
  (string) The node's name.

`ephemeral_id`::


`transport_address`::
  (string) Host and port where transport HTTP connections are accepted.

`attributes`::
  (object) {ml} attributes.
  `max_running_jobs`::: The maximum number of concurrently open jobs allowed per node.