Improve observability (#834)

* API generation * Added correlation id support * Updated docs * Updated test * Updated code generation * API generation * Updated code generation * Added support for client name and custom context object * Updated docs * Updated test * Fix docs * Updated docs * Added id support also for sniffing * Updated test * Update docs/observability.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Update docs/observability.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Apply suggestions * Update docs/configuration.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Update docs/configuration.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Update docs/observability.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Update docs/observability.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Update docs/observability.asciidoc Co-Authored-By: delvedor <delvedor@users.noreply.github.com> * Apply suggestions * Updated README.md * Fixed test * Addressed suggestions
elastic · May 3, 2019 · 14fc908 · 14fc908
1 parent 7d810f8
commit 14fc908
Show file tree

Hide file tree

Showing 279 changed files with 2,314 additions and 142 deletions.
diff --git a/README.md b/README.md
@@ -119,6 +119,10 @@ The client is designed to be easily configured as you see fit for your needs, fo
   nodeFilter: nodeFilterFn;
   // custom selection strategy, defaults `round-robin`
   nodeSelector: nodeSelectorFn | string;
+  // function to generate the request id for every request
+  generateRequestId: generateRequestIdFn;
+  // name to identify the client instance in the events
+  name: string;
 }
 ```
 
@@ -143,7 +147,9 @@ The supported *request specific options* are:
   asStream: boolean, // default `false`
   compression: string, // default `false`
   headers: object, // default `null`
-  querystring: object // default `null`
+  querystring: object // default `null`,
+  context: object // default `null`,
+  id: any // default incr. integer
 }
 ```
 

diff --git a/api/api/bulk.js b/api/api/bulk.js
@@ -138,6 +138,8 @@ function buildBulk (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.aliases.js b/api/api/cat.aliases.js
@@ -120,6 +120,8 @@ function buildCatAliases (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.allocation.js b/api/api/cat.allocation.js
@@ -122,6 +122,8 @@ function buildCatAllocation (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.count.js b/api/api/cat.count.js
@@ -120,6 +120,8 @@ function buildCatCount (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.fielddata.js b/api/api/cat.fielddata.js
@@ -124,6 +124,8 @@ function buildCatFielddata (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.health.js b/api/api/cat.health.js
@@ -117,6 +117,8 @@ function buildCatHealth (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.help.js b/api/api/cat.help.js
@@ -104,6 +104,8 @@ function buildCatHelp (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.indices.js b/api/api/cat.indices.js
@@ -126,6 +126,8 @@ function buildCatIndices (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.master.js b/api/api/cat.master.js
@@ -115,6 +115,8 @@ function buildCatMaster (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.nodeattrs.js b/api/api/cat.nodeattrs.js
@@ -115,6 +115,8 @@ function buildCatNodeattrs (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.nodes.js b/api/api/cat.nodes.js
@@ -118,6 +118,8 @@ function buildCatNodes (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.pending_tasks.js b/api/api/cat.pending_tasks.js
@@ -115,6 +115,8 @@ function buildCatPendingTasks (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.plugins.js b/api/api/cat.plugins.js
@@ -115,6 +115,8 @@ function buildCatPlugins (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.recovery.js b/api/api/cat.recovery.js
@@ -120,6 +120,8 @@ function buildCatRecovery (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.repositories.js b/api/api/cat.repositories.js
@@ -115,6 +115,8 @@ function buildCatRepositories (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.segments.js b/api/api/cat.segments.js
@@ -117,6 +117,8 @@ function buildCatSegments (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.shards.js b/api/api/cat.shards.js
@@ -122,6 +122,8 @@ function buildCatShards (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.snapshots.js b/api/api/cat.snapshots.js
@@ -121,6 +121,8 @@ function buildCatSnapshots (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.tasks.js b/api/api/cat.tasks.js
@@ -120,6 +120,8 @@ function buildCatTasks (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.templates.js b/api/api/cat.templates.js
@@ -120,6 +120,8 @@ function buildCatTemplates (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cat.thread_pool.js b/api/api/cat.thread_pool.js
@@ -122,6 +122,8 @@ function buildCatThreadPool (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.delete_auto_follow_pattern.js b/api/api/ccr.delete_auto_follow_pattern.js
@@ -96,6 +96,8 @@ function buildCcrDeleteAutoFollowPattern (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.follow.js b/api/api/ccr.follow.js
@@ -102,6 +102,8 @@ function buildCcrFollow (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.follow_info.js b/api/api/ccr.follow_info.js
@@ -90,6 +90,8 @@ function buildCcrFollowInfo (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.follow_stats.js b/api/api/ccr.follow_stats.js
@@ -90,6 +90,8 @@ function buildCcrFollowStats (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.forget_follower.js b/api/api/ccr.forget_follower.js
@@ -101,6 +101,8 @@ function buildCcrForgetFollower (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.get_auto_follow_pattern.js b/api/api/ccr.get_auto_follow_pattern.js
@@ -94,6 +94,8 @@ function buildCcrGetAutoFollowPattern (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.pause_follow.js b/api/api/ccr.pause_follow.js
@@ -96,6 +96,8 @@ function buildCcrPauseFollow (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.put_auto_follow_pattern.js b/api/api/ccr.put_auto_follow_pattern.js
@@ -101,6 +101,8 @@ function buildCcrPutAutoFollowPattern (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.resume_follow.js b/api/api/ccr.resume_follow.js
@@ -97,6 +97,8 @@ function buildCcrResumeFollow (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.stats.js b/api/api/ccr.stats.js
@@ -89,6 +89,8 @@ function buildCcrStats (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/ccr.unfollow.js b/api/api/ccr.unfollow.js
@@ -96,6 +96,8 @@ function buildCcrUnfollow (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/clear_scroll.js b/api/api/clear_scroll.js
@@ -100,6 +100,8 @@ function buildClearScroll (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.allocation_explain.js b/api/api/cluster.allocation_explain.js
@@ -101,6 +101,8 @@ function buildClusterAllocationExplain (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.get_settings.js b/api/api/cluster.get_settings.js
@@ -111,6 +111,8 @@ function buildClusterGetSettings (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.health.js b/api/api/cluster.health.js
@@ -132,6 +132,8 @@ function buildClusterHealth (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.pending_tasks.js b/api/api/cluster.pending_tasks.js
@@ -105,6 +105,8 @@ function buildClusterPendingTasks (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.put_settings.js b/api/api/cluster.put_settings.js
@@ -109,6 +109,8 @@ function buildClusterPutSettings (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.remote_info.js b/api/api/cluster.remote_info.js
@@ -100,6 +100,8 @@ function buildClusterRemoteInfo (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.reroute.js b/api/api/cluster.reroute.js
@@ -110,6 +110,8 @@ function buildClusterReroute (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.state.js b/api/api/cluster.state.js
@@ -137,6 +137,8 @@ function buildClusterState (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }
 

diff --git a/api/api/cluster.stats.js b/api/api/cluster.stats.js
@@ -110,6 +110,8 @@ function buildClusterStats (opts) {
       headers: options.headers || null,
       querystring: options.querystring || null,
       compression: options.compression || false,
+      id: options.id || null,
+      context: options.context || null,
       warnings
     }