summaryrefslogtreecommitdiff
path: root/osprofiler/drivers/elasticsearch_driver.py
diff options
context:
space:
mode:
authorMichael Johnson <johnsomor@gmail.com>2022-02-14 18:50:55 +0000
committerMichael Johnson <johnsomor@gmail.com>2022-02-17 22:35:09 +0000
commitb9206a5349724a179cf90fbd7f09555cfbbd7fd1 (patch)
tree6ddaabe7e9f10d7306d8d8131865eb5492819e30 /osprofiler/drivers/elasticsearch_driver.py
parenta2e5a66696242b0f7d0b2066c8606c9a029959d3 (diff)
downloadosprofiler-b9206a5349724a179cf90fbd7f09555cfbbd7fd1.tar.gz
Fix api index and module index
This patch fixes the index and module index for the osprofiler documentation home page. It also updates the documents tox environments to use a docs requirements.txt Change-Id: I880f1c28232a299f50ea9ccc2178f1444efb9a41
Diffstat (limited to 'osprofiler/drivers/elasticsearch_driver.py')
-rw-r--r--osprofiler/drivers/elasticsearch_driver.py13
1 files changed, 5 insertions, 8 deletions
diff --git a/osprofiler/drivers/elasticsearch_driver.py b/osprofiler/drivers/elasticsearch_driver.py
index d4a6b3d..da9be17 100644
--- a/osprofiler/drivers/elasticsearch_driver.py
+++ b/osprofiler/drivers/elasticsearch_driver.py
@@ -58,15 +58,12 @@ class ElasticsearchDriver(base.Driver):
:param info: Contains information about trace element.
In payload dict there are always 3 ids:
"base_id" - uuid that is common for all notifications
- related to one trace. Used to simplify
- retrieving of all trace elements from
- Elasticsearch.
+ related to one trace. Used to simplify retrieving of all
+ trace elements from Elasticsearch.
"parent_id" - uuid of parent element in trace
"trace_id" - uuid of current element in trace
-
With parent_id and trace_id it's quite simple to build
tree of trace elements, which simplify analyze of trace.
-
"""
info = info.copy()
@@ -111,9 +108,9 @@ class ElasticsearchDriver(base.Driver):
"""Query all traces from the storage.
:param fields: Set of trace fields to return. Defaults to 'base_id'
- and 'timestamp'
- :return List of traces, where each trace is a dictionary containing
- at least `base_id` and `timestamp`.
+ and 'timestamp'
+ :returns: List of traces, where each trace is a dictionary containing
+ at least `base_id` and `timestamp`.
"""
query = {"match_all": {}}
fields = set(fields or self.default_trace_fields)