Elasticsearch

https://www.elastic.co/docs/reference
Admin
Elasticsearch is a distributed search and analytics engine that provides powerful full-text search,...
Tokens:8,015,375
Snippets:62,730
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### winlogbeat setup command examples

Source: https://www.elastic.co/docs/reference/beats/winlogbeat/command-line-options

Examples of using the `setup` command with the `--dashboards` and `--index-management` flags to set up specific assets.

```shell
winlogbeat setup --dashboards
winlogbeat setup --index-management
		
```

--------------------------------

### auditbeat setup examples

Source: https://www.elastic.co/docs/reference/beats/auditbeat/command-line-options

Examples of the setup command with flags to load Kibana dashboards or set up index management components (template, ILM policy, write alias).

```shell
auditbeat setup --dashboards
auditbeat setup --index-management
		
```

--------------------------------

### Install ECE on first host for multi-zone setup

Source: https://www.elastic.co/docs/reference/cloud/cloud-enterprise/ece-installation-script

Starts a multi-host installation by installing on the first host with a runner ID and availability zone.

```bash
bash elastic-cloud-enterprise.sh install --runner-id runner-10.142.0.1 --availability-zone zone-1a

```

--------------------------------

### packetbeat setup --dashboards and --index-management examples

Source: https://www.elastic.co/docs/reference/beats/packetbeat/command-line-options

Examples of the `setup` command with flags to load Kibana dashboards and set up index management components (template, ILM policy, write alias).

```shell
packetbeat setup --dashboards
packetbeat setup --index-management
		
```

--------------------------------

### filebeat setup command examples

Source: https://www.elastic.co/docs/reference/beats/filebeat/command-line-options

Example invocations of the `setup` command with various flags: `--dashboards`, `--pipelines`, `--modules`, and `--index-management`. Use these to set up specific subsets of assets.

```shell
filebeat setup --dashboards
filebeat setup --pipelines
filebeat setup --pipelines --modules system,nginx,mysql
filebeat setup --index-management
		
```

--------------------------------

### Complete installation example

Source: https://www.elastic.co/docs/reference/elasticsearch/clients/go/installation

A complete example showing how to create a new Go module, install the client, create a main.go file that uses the client, and run it. The program prints the client version and the result of an Info request.

```bash
mkdir my-elasticsearch-app && cd my-elasticsearch-app && go mod init my-elasticsearch-app
```

```bash
go get github.com/elastic/go-elasticsearch/v9@v9.5.2
```

```bash
cat > main.go <<-END
  package main

  import (
    "context"
    "log"

    "github.com/elastic/go-elasticsearch/v9"
  )

  func main() {
    es, _ := elasticsearch.NewTyped()
    defer es.Close(context.Background())
    log.Println(elasticsearch.Version)
    log.Println(es.Info().Do(context.Background()))
  }
END
```

```bash
go run main.go
```

--------------------------------

### Import default stylesheet

Source: https://www.elastic.co/docs/reference/search-ui/basic-usage

Imports the default Search UI stylesheet to get started quickly.

```css
import "@elastic/react-search-ui-views/lib/styles/styles.css";
```

--------------------------------

### Install Site Search Connector

Source: https://www.elastic.co/docs/reference/search-ui/api-connectors-site-search

Install the @elastic/search-ui-site-search-connector package using npm.

```bash
npm install --save @elastic/search-ui-site-search-connector
		
```

--------------------------------

### Installation

Source: https://www.elastic.co/docs/reference/search-ui/api-connectors-app-search

Install the App Search Connector package via npm.

```APIDOC
## Install

```
npm install --save @elastic/search-ui-app-search-connector
```
```

--------------------------------

### Installation

Source: https://www.elastic.co/docs/reference/search-ui/api-connectors-workplace-search

Install the Workplace Search Connector package via npm.

```APIDOC
## Installation

### Description
Install the Workplace Search Connector package via npm.

### Command
```bash
npm install --save @elastic/search-ui-workplace-search-connector
```
```

--------------------------------

### Installation

Source: https://www.elastic.co/docs/reference/search-ui/api-connectors-site-search

Install the Site Search Connector package via npm.

```APIDOC
## Installation

### Description
Install the Site Search Connector package via npm.

### Command
```
npm install --save @elastic/search-ui-site-search-connector
```
```

--------------------------------

### Install Elasticsearch connector

Source: https://www.elastic.co/docs/reference/search-ui/tutorials-elasticsearch-install-connector

Installs the @elastic/search-ui-elasticsearch-connector library using Yarn.

```bash
yarn add @elastic/search-ui-elasticsearch-connector
		
```

--------------------------------

### Install @elastic/search-ui-workplace-search-connector

Source: https://www.elastic.co/docs/reference/search-ui/api-connectors-workplace-search

Install the Workplace Search connector package via npm.

```bash
npm install --save @elastic/search-ui-workplace-search-connector
		
```

--------------------------------

### Install dependencies with Yarn

Source: https://www.elastic.co/docs/reference/search-ui/tutorials-elasticsearch-install-connector

Installs the project dependencies using Yarn.

```bash
yarn
		
```

--------------------------------

### Install and configure EDOT Node.js

Source: https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/node/setup

Minimal setup steps for EDOT Node.js: install the @elastic/opentelemetry-node package, configure the OTLP endpoint, API key header, and service name via environment variables, then start the application with the Node.js import flag. Requires an Elastic Observability deployment and the ELASTIC_OTLP_ENDPOINT and ELASTIC_API_KEY values from the EDOT Quickstart guide.

```bash
# Install it
npm install --save @elastic/opentelemetry-node

# Configure it
export OTEL_EXPORTER_OTLP_ENDPOINT="...your-ELASTIC_OTLP_ENDPOINT..."
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=ApiKey ...your-ELASTIC_API_KEY..."
export OTEL_SERVICE_NAME="my-app"

# Start it with your application
node --import @elastic/opentelemetry-node my-app.js
```

--------------------------------

### Get user

Source: https://www.elastic.co/docs/reference/kibana/connectors-kibana/microsoft-teams-action-type

Looks up a user by ID (GUID) or user principal name (UPN, for example `alice@contoso.com`). Useful for resolving an email address to a GUID before calling `createChat`.

```APIDOC
## Get user

### Description
Looks up a user by ID (GUID) or user principal name (UPN, for example `alice@contoso.com`). Useful for resolving an email address to a GUID before calling `createChat`.

### Parameters
#### Request Body
- **userId** (string) - Required - The user ID (GUID) or UPN to look up.
```

--------------------------------

### Start a transaction with StartTransaction

Source: https://www.elastic.co/docs/reference/apm/agents/go/api-documentation

Call StartTransaction at the beginning of a transaction such as a web or RPC request. The example starts a transaction named "GET /" of type "request".

```go
transaction := apm.DefaultTracer().StartTransaction("GET /", "request")
```

--------------------------------

### Example activity log output

Source: https://www.elastic.co/docs/reference/cloud/cloud-enterprise/ece-restful-api-examples-progress-checking

This abridged example shows the format of the activity log messages. It includes steps like 'Starting step' and 'Plan successfully constructed'. Use grep on `"message": "Completed step:` to get highlights.

```text
"message": "Starting step: [plan-validator]: [cluster=ElasticsearchCluster(1e5675defe924b14af39136bd476fe36), stat=4294980506,4294980506,1544207967588,1544207967588,0,0,0,0,1403,0,4294980506\n]"
...
"message": "Plan successfully constructed: [PlanSuccessful()]"
		
```

--------------------------------

### Install ECE on first host with additional parameters

Source: https://www.elastic.co/docs/reference/cloud/cloud-enterprise/ece-installation-script

Starts a new installation with parameters to set the runner ID, host IP address, availability zone, capacity, and the required roles token.

```bash
bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --runner-id runner-1 --host-ip 10.142.0.4 --availability-zone zone-1a --capacity 30000 --roles-token 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2ZDE2ZDY3YS01NGUzLTQ0MzMtYTlmZC05MTJjYzQwZmIxYmQiLCJyb2xlcyI6W10sImlzcyI6ImN1cnJlbnQiLCJwZXJzaXN0ZW50Ijp0cnVlfQ.MGEpEj0JmUGuucazf55sURNX-Q6QIMhKP0gdNJ2-vnk'

```

--------------------------------

### Create index mapping with long fields for measures object

Source: https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples

Adds a 'measures' object with 'start' and 'end' fields of type 'long' to the mappings of 'my-index-000001'. This setup is required for the subsequent long_field script example.

```json
PUT /my-index-000001/
{
  "mappings": {
    "properties": {
      "measures": {
        "properties": {
          "start": {
            "type": "long"
          },
          "end": {
           "type": "long"
          }
        }
      }
    }
  }
}
```

--------------------------------

### ecctl platform repository create examples

Source: https://www.elastic.co/docs/reference/ecctl/ecctl_platform_repository_create

Three examples of using the create command: creating a repository with a settings file, updating a repository (using the update command), and creating a custom repository with the --type flag set to 'fs'.

```bash
ecctl platform repository create my-snapshot-repo --settings settings.yml

ecctl platform repository update my-snapshot-repo --settings settings.yml

ecctl platform repository create custom --type fs --settings settings.yml
		
```

--------------------------------

### LOCATE function example with start

Source: https://www.elastic.co/docs/reference/query-languages/sql/sql-functions-string

Example query using LOCATE with a start position of 5 to find the first occurrence of 'a' in 'Elasticsearch' starting from the 5th character. The output is 10.

```sql
SELECT LOCATE('a', 'Elasticsearch', 5);

LOCATE('a', 'Elasticsearch', 5)
-------------------------------
10
		
```

--------------------------------

### filebeat setup command synopsis

Source: https://www.elastic.co/docs/reference/beats/filebeat/command-line-options

Shows the basic syntax for the `setup` command. Use this to set up the environment without running Filebeat.

```shell
filebeat setup [FLAGS]
		
```

--------------------------------

### Create and customize a span with the span API

Source: https://www.elastic.co/docs/reference/apm/agents/java/method-api

Use ElasticApm.currentSpan() to get the current span, then start a child span, activate it, and customize it with setName and addLabel. The example shows exception capture and span ending in a finally block.

```java
import co.elastic.apm.api.ElasticApm;
import co.elastic.apm.api.Span;

Span parent = ElasticApm.currentSpan();
Span span = parent.startSpan();
try (Scope scope = span.activate()) {
    span.setName("SELECT FROM customer");
    span.addLabel("foo", "bar");
    // do your thing...
} catch (Exception e) {
    span.captureException(e);
    throw e;
} finally {
    span.end();
}
```

--------------------------------

### winlogbeat setup command synopsis

Source: https://www.elastic.co/docs/reference/beats/winlogbeat/command-line-options

Shows the syntax for the `setup` command, which sets up the initial environment without running Winlogbeat or ingesting data.

```shell
winlogbeat setup [FLAGS]
		
```

--------------------------------

### setup.template.settings example

Source: https://www.elastic.co/docs/reference/beats/filebeat/configuration-template

Example configuration for setting index settings such as number_of_shards and number_of_replicas via the setup.template.settings dictionary.

```yaml
setup.template.name: "filebeat"
setup.template.fields: "fields.yml"
setup.template.overwrite: false
setup.template.settings:
  index.number_of_shards: 1
  index.number_of_replicas: 1

```

--------------------------------

### Install Elastic Agent with Helm (example values)

Source: https://www.elastic.co/docs/reference/fleet/example-kubernetes-standalone-agent-helm

Example install command with actual endpoint and API key values, showing the expected format after substitution.

```bash
helm install demo elastic/elastic-agent \
--set kubernetes.enabled=true \
--set system.enabled=true \
--set outputs.default.type=ESPlainAuthAPI \
--set outputs.default.url=https://demo.es.us-central1.gcp.foundit.no:443 \
--set outputs.default.api_key="A6ecaHNTJUFFcJI6esf4:5HJPxxxxxxxPS4KwSBeVEs"
		
```

--------------------------------

### Install Go client with go get

Source: https://www.elastic.co/docs/reference/elasticsearch/clients/go/installation

Use the go get command to install the 9.x version of the Elasticsearch Go client. The version v9.5.2 is specified in the command.

```bash
go get github.com/elastic/go-elasticsearch/v9@v9.5.2
```
Tokens:
Raw