Skip to content

[ON Week] Add language examples to ESQL security tutorial #3913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

[ON Week] Add language examples to ESQL security tutorial #3913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba39446
[ON Week] Add language examples to ESQL security tutorial
leemthompo Nov 12, 2025
de6d779
fix dynamic languages setup code
leemthompo Nov 13, 2025
37aaa02
Refactor to use snippet includes
leemthompo Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions ...ty/esql-for-security/_snippets/esql-threat-hunting-tutorial/example1-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
```console
PUT /windows-security-logs
{
"mappings": {
"properties": {
"@timestamp": {"type": "date"},
"event": {
"properties": {
"code": {"type": "keyword"}, # Event codes like 4624 (successful logon) and 4625 (failed logon) are stored as keywords for exact matching.
"action": {"type": "keyword"}
}
},
"user": {
"properties": {
"name": {"type": "keyword"},
"domain": {"type": "keyword"}
}
},
"host": {
"properties": {
"name": {"type": "keyword"},
"ip": {"type": "ip"}
}
},
"source": {
"properties": {
"ip": {"type": "ip"}
}
},
"logon": {
"properties": {
"type": {"type": "keyword"}
}
}
}
}
}
```
6 changes: 6 additions & 0 deletions ...urity/esql-for-security/_snippets/esql-threat-hunting-tutorial/example1-curl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```bash
curl -X PUT "$ELASTICSEARCH_URL/windows-security-logs" \
-H "Authorization: ApiKey $ELASTIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"mappings":{"properties":{"@timestamp":{"type":"date"},"event":{"properties":{"code":{"type":"keyword"},"action":{"type":"keyword"}}},"user":{"properties":{"name":{"type":"keyword"},"domain":{"type":"keyword"}}},"host":{"properties":{"name":{"type":"keyword"},"ip":{"type":"ip"}}},"source":{"properties":{"ip":{"type":"ip"}}},"logon":{"properties":{"type":{"type":"keyword"}}}}}}'
```
70 changes: 70 additions & 0 deletions ...ecurity/esql-for-security/_snippets/esql-threat-hunting-tutorial/example1-js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
```js
const { Client } = require("@elastic/elasticsearch");

const client = new Client({
nodes: [process.env["ELASTICSEARCH_URL"]],
auth: {
apiKey: process.env["ELASTIC_API_KEY"],
},
});

async function run() {
const response = await client.indices.create({
index: "windows-security-logs",
mappings: {
properties: {
"@timestamp": {
type: "date",
},
event: {
properties: {
code: {
type: "keyword",
},
action: {
type: "keyword",
},
},
},
user: {
properties: {
name: {
type: "keyword",
},
domain: {
type: "keyword",
},
},
},
host: {
properties: {
name: {
type: "keyword",
},
ip: {
type: "ip",
},
},
},
source: {
properties: {
ip: {
type: "ip",
},
},
},
logon: {
properties: {
type: {
type: "keyword",
},
},
},
},
},
});
console.log(response);
}

run();
```
71 changes: 71 additions & 0 deletions ...curity/esql-for-security/_snippets/esql-threat-hunting-tutorial/example1-php.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
```php
<?php

require(__DIR__ . "/vendor/autoload.php");

use Elastic\Elasticsearch\ClientBuilder;

$client = ClientBuilder::create()
->setHosts([getenv("ELASTICSEARCH_URL")])
->setApiKey(getenv("ELASTIC_API_KEY"))
->build();

$resp = $client->indices()->create([
"index" => "windows-security-logs",
"body" => [
"mappings" => [
"properties" => [
"@timestamp" => [
"type" => "date",
],
"event" => [
"properties" => [
"code" => [
"type" => "keyword",
],
"action" => [
"type" => "keyword",
],
],
],
"user" => [
"properties" => [
"name" => [
"type" => "keyword",
],
"domain" => [
"type" => "keyword",
],
],
],
"host" => [
"properties" => [
"name" => [
"type" => "keyword",
],
"ip" => [
"type" => "ip",
],
],
],
"source" => [
"properties" => [
"ip" => [
"type" => "ip",
],
],
],
"logon" => [
"properties" => [
"type" => [
"type" => "keyword",
],
],
],
],
],
],
]);
echo $resp->asString();

```
66 changes: 66 additions & 0 deletions ...ity/esql-for-security/_snippets/esql-threat-hunting-tutorial/example1-python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
```python
import os
from elasticsearch import Elasticsearch

client = Elasticsearch(
hosts=[os.getenv("ELASTICSEARCH_URL")],
api_key=os.getenv("ELASTIC_API_KEY"),
)

resp = client.indices.create(
index="windows-security-logs",
mappings={
"properties": {
"@timestamp": {
"type": "date"
},
"event": {
"properties": {
"code": {
"type": "keyword"
},
"action": {
"type": "keyword"
}
}
},
"user": {
"properties": {
"name": {
"type": "keyword"
},
"domain": {
"type": "keyword"
}
}
},
"host": {
"properties": {
"name": {
"type": "keyword"
},
"ip": {
"type": "ip"
}
}
},
"source": {
"properties": {
"ip": {
"type": "ip"
}
}
},
"logon": {
"properties": {
"type": {
"type": "keyword"
}
}
}
}
},
)
print(resp)

```
67 changes: 67 additions & 0 deletions ...urity/esql-for-security/_snippets/esql-threat-hunting-tutorial/example1-ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
```ruby
require "elasticsearch"

client = Elasticsearch::Client.new(
host: ENV["ELASTICSEARCH_URL"],
api_key: ENV["ELASTIC_API_KEY"]
)

response = client.indices.create(
index: "windows-security-logs",
body: {
"mappings": {
"properties": {
"@timestamp": {
"type": "date"
},
"event": {
"properties": {
"code": {
"type": "keyword"
},
"action": {
"type": "keyword"
}
}
},
"user": {
"properties": {
"name": {
"type": "keyword"
},
"domain": {
"type": "keyword"
}
}
},
"host": {
"properties": {
"name": {
"type": "keyword"
},
"ip": {
"type": "ip"
}
}
},
"source": {
"properties": {
"ip": {
"type": "ip"
}
}
},
"logon": {
"properties": {
"type": {
"type": "keyword"
}
}
}
}
}
}
)
print(resp)

```
19 changes: 19 additions & 0 deletions ...y/esql-for-security/_snippets/esql-threat-hunting-tutorial/example10-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
```console
POST /_bulk?refresh=wait_for
{"index":{"_index":"asset-inventory"}}
{"host.name":"WS-001","asset.criticality":"medium","asset.owner":"IT","asset.department":"finance"}
{"index":{"_index":"asset-inventory"}}
{"host.name":"SRV-001","asset.criticality":"high","asset.owner":"IT","asset.department":"operations"}
{"index":{"_index":"asset-inventory"}}
{"host.name":"DB-001","asset.criticality":"critical","asset.owner":"DBA","asset.department":"finance"}
{"index":{"_index":"asset-inventory"}}
{"host.name":"DC-001","asset.criticality":"critical","asset.owner":"IT","asset.department":"infrastructure"}
{"index":{"_index":"user-context"}}
{"user.name":"jsmith","user.role":"analyst","user.department":"finance","user.privileged":false}
{"index":{"_index":"user-context"}}
{"user.name":"admin","user.role":"administrator","user.department":"IT","user.privileged":true}
{"index":{"_index":"threat-intel"}}
{"indicator.value":"185.220.101.45","indicator.type":"ip","threat.name":"APT-29","threat.severity":"high"}
{"index":{"_index":"threat-intel"}}
{"indicator.value":"powershell.exe","indicator.type":"process","threat.name":"Living off the Land","threat.severity":"medium"}
```
6 changes: 6 additions & 0 deletions ...rity/esql-for-security/_snippets/esql-threat-hunting-tutorial/example10-curl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```bash
curl -X POST "$ELASTICSEARCH_URL/_bulk?refresh=wait_for" \
-H "Authorization: ApiKey $ELASTIC_API_KEY" \
-H "Content-Type: application/x-ndjson" \
-d $'{"index":{"_index":"asset-inventory"}}\n{"host.name":"WS-001","asset.criticality":"medium","asset.owner":"IT","asset.department":"finance"}\n{"index":{"_index":"asset-inventory"}}\n{"host.name":"SRV-001","asset.criticality":"high","asset.owner":"IT","asset.department":"operations"}\n{"index":{"_index":"asset-inventory"}}\n{"host.name":"DB-001","asset.criticality":"critical","asset.owner":"DBA","asset.department":"finance"}\n{"index":{"_index":"asset-inventory"}}\n{"host.name":"DC-001","asset.criticality":"critical","asset.owner":"IT","asset.department":"infrastructure"}\n{"index":{"_index":"user-context"}}\n{"user.name":"jsmith","user.role":"analyst","user.department":"finance","user.privileged":false}\n{"index":{"_index":"user-context"}}\n{"user.name":"admin","user.role":"administrator","user.department":"IT","user.privileged":true}\n{"index":{"_index":"threat-intel"}}\n{"indicator.value":"185.220.101.45","indicator.type":"ip","threat.name":"APT-29","threat.severity":"high"}\n{"index":{"_index":"threat-intel"}}\n{"indicator.value":"powershell.exe","indicator.type":"process","threat.name":"Living off the Land","threat.severity":"medium"}\n'
```
Loading
Loading