Merge branch 'main' into codegen

Author: margaretjgu

.github/workflows/nodejs.yml

@@ -26,8 +26,8 @@ jobs:
     name: Test
     runs-on: ${{ matrix.os }}
     needs: paths-filter
-    # only run if code relevant to unit tests was changed
-    if: needs.paths-filter.outputs.src-only == 'true'
+    env:
+      CODE_CHANGED: ${{ needs.paths-filter.outputs.src-only }}
 
     strategy:
       fail-fast: false
@@ -50,16 +50,19 @@ jobs:
           npm install
 
       - name: Lint
+        shell: bash
         run: |
-          npm run lint
+          [ "$CODE_CHANGED" = "true" ] && npm run lint || exit 0
 
       - name: Unit test
+        shell: bash
         run: |
-          npm run test:unit
+          [ "$CODE_CHANGED" = "true" ] && npm run test:unit || exit 0
 
       - name: ECMAScript module test
+        shell: bash
         run: |
-          npm run test:esm
+          [ "$CODE_CHANGED" = "true" ] && npm run test:esm || exit 0
 
   license:
     name: License check
@@ -90,8 +93,8 @@ jobs:
     name: Test Bun
     runs-on: ${{ matrix.os }}
     needs: paths-filter
-    # only run if code relevant to unit tests was changed
-    if: needs.paths-filter.outputs.src-only == 'true'
+    env:
+      CODE_CHANGED: ${{ needs.paths-filter.outputs.src-only }}
 
     strategy:
       fail-fast: false
@@ -111,13 +114,16 @@ jobs:
           bun install
 
       - name: Lint
+        shell: bash
         run: |
-          bun run lint
+          [ "$CODE_CHANGED" = "true" ] && bun run lint || exit 0
 
       - name: Unit test
+        shell: bash
         run: |
-          bun run test:unit-bun
+          [ "$CODE_CHANGED" = "true" ] && bun run test:unit-bun || exit 0
 
       - name: ECMAScript module test
+        shell: bash
         run: |
-          bun run test:esm
+          [ "$CODE_CHANGED" = "true" ] && bun run test:esm || exit 0

docs/docset.yml

@@ -6,6 +6,7 @@ exclude:
 cross_links:
   - docs-content
   - elasticsearch
+  - elastic-otel-node
 toc:
   - toc: reference
   - toc: release-notes

docs/reference/api-reference.md

@@ -5,41 +5,21 @@ mapped_pages:
 
 # Observability [observability]
 
-To observe and measure {{es}} client usage, several client features are provided.
+Several client features help you observe and measure {{es}} client usage. As of version 8.15.0, the JavaScript client provides native support for OpenTelemetry. You can send client usage data to OpenTelemetry endpoints without making changes to your JavaScript codebase. 
 
-First, as of 8.15.0, the client provides native support for OpenTelemetry, which allows you to send client usage data to any endpoint that supports OpenTelemetry without having to make any changes to your JavaScript codebase.
-
-Also, rather than providing a default logger, the client offers an event emitter interface to hook into internal events, such as `request` and `response`, allowing you to log the events you care about, or otherwise react to client usage however you might need.
-
-Correlating events can be hard, especially if your applications have a large codebase with many events happening at the same time. To help you with this, the client provides a correlation ID system, and other features.
-
-All of these observability features are documented below.
+Rather than providing a default logger, the client offers an event emitter interface to hook into internal events like `request` and `response`. This allows you to log significant events or otherwise react to client usage. Because correlating events can be complex, the client provides a correlation ID system and other features.
 
 ## OpenTelemetry [_opentelemetry]
 
 The client supports OpenTelemetry’s [zero-code instrumentation](https://opentelemetry.io/docs/zero-code/js/) to enable tracking each client request as an [OpenTelemetry span](https://opentelemetry.io/docs/concepts/signals/traces/#spans). These spans follow all of the [semantic OpenTelemetry conventions for {{es}}](https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/) except for `db.query.text`.
 
-To start sending {{es}} trace data to your OpenTelemetry endpoint, follow [OpenTelemetry’s zero-code instrumentation guide](https://opentelemetry.io/docs/zero-code/js/), or the following steps:
-
-1. Install `@opentelemetry/api` and `@opentelemetry/auto-instrumentations-node` as Node.js dependencies
-2. Export the following environment variables with the appropriate values:
-
-    * `OTEL_EXPORTER_OTLP_ENDPOINT`
-    * `OTEL_EXPORTER_OTLP_HEADERS`
-    * `OTEL_RESOURCE_ATTRIBUTES`
-    * `OTEL_SERVICE_NAME`
-
-3. `require` the Node.js auto-instrumentation library at startup:
-
-```
-node --require '@opentelemetry/auto-instrumentations-node/register' index.js
-```
+To start sending {{es}} trace data to your OpenTelemetry endpoint, instrument the client using the [Elastic Distribution of OpenTelemetry (EDOT) JavaScript](elastic-otel-node://reference/edot-node/index.md), or follow [OpenTelemetry’s zero-code instrumentation guide](https://opentelemetry.io/docs/zero-code/js/).
 
-### Disabling OpenTelemetry collection [disable-otel]
+### Turn off OpenTelemetry collection [disable-otel]
 
-As of `@elastic/transport` version 9.1.0—or 8.10.0 when using `@elastic/elasticsearch` 8.x—OpenTelemetry tracing can be disabled in multiple ways.
+As of `@elastic/transport` version 9.1.0—or 8.10.0 when using `@elastic/elasticsearch` 8.x—you can turn off OpenTelemetry tracing in several ways.
 
-To entirely disable OpenTelemetry collection, you can provide a custom `Transport` at client instantiation time that sets `openTelemetry.enabled` to `false`:
+To entirely turn off OpenTelemetry collection, you can provide a custom `Transport` at client instantiation time that sets `openTelemetry.enabled` to `false`:
 
 ```typescript
 import { Transport } from '@elastic/transport'
@@ -58,11 +38,11 @@ const client = new Client({
 })
 ```
 
-Alternatively, you can also export an environment variable `OTEL_ELASTICSEARCH_ENABLED=false` to achieve the same effect.
+Alternatively, you can export the environment variable `OTEL_ELASTICSEARCH_ENABLED=false`.
 
-If you would not like OpenTelemetry to be disabled entirely, but would like the client to suppress tracing, you can use the option `openTelemetry.suppressInternalInstrumentation = true` instead.
+To suppress tracing without turning off all OpenTelemetry collection, use the option `openTelemetry.suppressInternalInstrumentation = true` instead.
 
-If you would like to keep either option enabled by default, but want to disable them for a single API call, you can pass `Transport` options as a second argument to any API function call:
+If you would like to keep either option enabled by default, but want to turn them off for a single API call, pass `Transport` options as a second argument to any API function call:
 
 ```typescript
 const response = await client.search({ ... }, {

docs/reference/observability.md

@@ -20,7 +20,15 @@ To check for security updates, go to [Security announcements for the Elastic sta
 % ### Fixes [elasticsearch-javascript-client-next-fixes]
 % \*
 
-## 9.1.1
+## 9.2.0 [elasticsearch-javascript-client-9.2.0-release-notes]
+
+### Features and enhancements [elasticsearch-javascript-client-9.2.0-features-enhancements]
+
+- **Compatibility with Elasticsearch 9.2:** All changes and additions to Elasticsearch APIs for its 9.2 release are reflected in this release.
+
+- **Accepted parameter names added to transport request metadata:** All requests sent through `@elastic/transport` already included some metadata about the request (API name, path parameters). An `acceptedParams` array has been added that includes the names of all parameters that an API supports. This helps support more flexible pre-flight request modifications made by custom transports.
+
+## 9.1.1 [elasticsearch-javascript-client-9.1.1-release-notes]
 
 ### Fixes [elasticsearch-javascript-client-9.1.1-fixes]
 

docs/release-notes/index.md

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "9.1.0",
-  "versionCanary": "9.1.0-canary.0",
+  "version": "9.2.0",
+  "versionCanary": "9.2.0-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "main": "./index.js",
   "types": "index.d.ts",
@@ -80,10 +80,10 @@
     "ora": "5.4.1",
     "proxy": "2.2.0",
     "rimraf": "6.0.1",
-    "semver": "7.7.2",
+    "semver": "7.7.3",
     "split2": "4.2.0",
     "stoppable": "1.1.0",
-    "tap": "21.1.0",
+    "tap": "21.1.3",
     "ts-node": "10.9.2",
     "ts-standard": "12.0.2",
     "typescript": "5.9.2",

package.json

@@ -58,6 +58,13 @@ export default class Cat {
           'master_timeout'
         ]
       },
+      'cat.circuit_breaker': {
+        path: [
+          'circuit_breaker_patterns'
+        ],
+        body: [],
+        query: []
+      },
       'cat.component_templates': {
         path: [
           'name'
@@ -251,7 +258,12 @@ export default class Cat {
           'h',
           's',
           'local',
-          'master_timeout'
+          'master_timeout',
+          'expand_wildcards',
+          'allow_no_indices',
+          'ignore_throttled',
+          'ignore_unavailable',
+          'allow_closed'
         ]
       },
       'cat.shards': {
@@ -451,6 +463,61 @@ export default class Cat {
     return await this.transport.request({ path, method, querystring, body, meta }, options)
   }
 
+  /**
+    * Get circuit breakers statistics
+    * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch#TODO | Elasticsearch API documentation}
+    */
+  async circuitBreaker (this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
+  async circuitBreaker (this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
+  async circuitBreaker (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>
+  async circuitBreaker (this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<any> {
+    const {
+      path: acceptedPath
+    } = this[kAcceptedParams]['cat.circuit_breaker']
+
+    const userQuery = params?.querystring
+    const querystring: Record<string, any> = userQuery != null ? { ...userQuery } : {}
+
+    let body: Record<string, any> | string | undefined
+    const userBody = params?.body
+    if (userBody != null) {
+      if (typeof userBody === 'string') {
+        body = userBody
+      } else {
+        body = { ...userBody }
+      }
+    }
+
+    params = params ?? {}
+    for (const key in params) {
+      if (acceptedPath.includes(key)) {
+        continue
+      } else if (key !== 'body' && key !== 'querystring') {
+        querystring[key] = params[key]
+      }
+    }
+
+    let method = ''
+    let path = ''
+    if (params.circuit_breaker_patterns != null) {
+      method = 'GET'
+      path = `/_cat/circuit_breaker/${encodeURIComponent(params.circuit_breaker_patterns.toString())}`
+    } else {
+      method = 'GET'
+      path = '/_cat/circuit_breaker'
+    }
+    const meta: TransportRequestMetadata = {
+      name: 'cat.circuit_breaker',
+      pathParts: {
+        circuit_breaker_patterns: params.circuit_breaker_patterns
+      },
+      acceptedParams: [
+        'circuit_breaker_patterns'
+      ]
+    }
+    return await this.transport.request({ path, method, querystring, body, meta }, options)
+  }
+
   /**
     * Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
     * @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates | Elasticsearch API documentation}
@@ -1434,7 +1501,12 @@ export default class Cat {
         'h',
         's',
         'local',
-        'master_timeout'
+        'master_timeout',
+        'expand_wildcards',
+        'allow_no_indices',
+        'ignore_throttled',
+        'ignore_unavailable',
+        'allow_closed'
       ]
     }
     return await this.transport.request({ path, method, querystring, body, meta }, options)