mirror of
https://codeberg.org/scip/esctl.git
synced 2026-08-25 00:34:17 +02:00
Compare commits
2 Commits
enhance/go
...
feature/ap
| Author | SHA1 | Date | |
|---|---|---|---|
| 34669ac4de | |||
| 45ba38bda9 |
28
README.md
28
README.md
@@ -29,7 +29,6 @@ Features:
|
||||
logical condition (OR, AND), use PIT, limit datetime (ES date math
|
||||
can be used), etc. It is however not yet possible to create
|
||||
recursive searches like: `(cond1 AND cond2) OR (cond3 OR cond4)`.
|
||||
- Search using ES|QL language: `esctl searchql`.
|
||||
- Cross cluster replication (ccr): view, pause, resume, delete
|
||||
replication. You can also manage follower configuration.
|
||||
- Index management: manage aliases, create, modify, delete indices,
|
||||
@@ -353,30 +352,6 @@ $ esctl search -i foo* -F title=zeitbuchung message=pause | jq
|
||||
}
|
||||
```
|
||||
|
||||
You can also search using [ES|QL](https://www.elastic.co/docs/reference/query-languages/esql/esql-getting-started):
|
||||
|
||||
```console
|
||||
$ esctl searchql "from hyperdrive | sort @timestamp | limit 5"
|
||||
@TIMESTAMP MESSAGE TAG
|
||||
2026-06-24T08:24:56.000Z arosu loop
|
||||
2026-06-24T08:24:58.000Z hami loop
|
||||
2026-06-24T08:24:59.000Z ishininu loop
|
||||
2026-06-24T08:25:00.000Z uyomoruron loop
|
||||
2026-06-24T08:25:02.000Z ishimime loop
|
||||
```
|
||||
|
||||
There are several output modes (json, yaml, csv), to get esql output as CSV:
|
||||
|
||||
```console
|
||||
$ esctl searchql "from hyperdrive | sort @timestamp | limit 5" -o csv
|
||||
@timestamp,message,tag
|
||||
2026-06-24T08:24:56.000Z,arosu,loop
|
||||
2026-06-24T08:24:58.000Z,hami,loop
|
||||
2026-06-24T08:24:59.000Z,ishininu,loop
|
||||
2026-06-24T08:25:00.000Z,uyomoruron,loop
|
||||
2026-06-24T08:25:02.000Z,ishimime,loop
|
||||
```
|
||||
|
||||
To check which field mappings are available for an index:
|
||||
```console
|
||||
$ esctl index show foo2
|
||||
@@ -563,7 +538,6 @@ index - manage indicies
|
||||
close - close an index
|
||||
fields - show info about field capabilities
|
||||
ilm - show ilm status
|
||||
du - show index disk usage
|
||||
alias - manage index aliases
|
||||
create - create an index alias
|
||||
list - list index aliases
|
||||
@@ -581,7 +555,6 @@ node - manage nodes
|
||||
list - list nodes
|
||||
show - show details about a node
|
||||
clients - show node http clients
|
||||
usage - show node usage stats
|
||||
role - manage roles
|
||||
list - list roles
|
||||
show - show details about a role
|
||||
@@ -601,7 +574,6 @@ version - show esctl version information
|
||||
debug - developer only
|
||||
help-jsonpath - show jsonpath help
|
||||
help-usage - show overview of all available commands
|
||||
help-esql - show esql help
|
||||
```
|
||||
|
||||
# Development
|
||||
|
||||
@@ -24,11 +24,10 @@ import (
|
||||
"github.com/go-openapi/swag/loading"
|
||||
)
|
||||
|
||||
//go:embed *.json *.md
|
||||
//go:embed *.json
|
||||
var AssetFS embed.FS
|
||||
|
||||
var OpenAPI *loads.Document
|
||||
var EsQlCheatSheet string
|
||||
|
||||
func LoadAssetOpenApi() {
|
||||
doc, err := loads.Spec(
|
||||
@@ -42,12 +41,3 @@ func LoadAssetOpenApi() {
|
||||
|
||||
OpenAPI = doc
|
||||
}
|
||||
|
||||
func LoadEsql() {
|
||||
md, err := AssetFS.ReadFile("esql.md")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
EsQlCheatSheet = string(md)
|
||||
}
|
||||
|
||||
951
assets/esql.md
951
assets/esql.md
@@ -1,951 +0,0 @@
|
||||
<!-- courtesy https://github.com/linkan-per/ES-QL-Cheat-Sheet by |linkan-per -->
|
||||
# ES|QL (Elasticsearch Query Language) Cheat Sheet
|
||||
|
||||
## Table of Contents
|
||||
1. [Introduction](#introduction)
|
||||
2. [Basic Query Structure](#basic-query-structure)
|
||||
3. [Source Commands](#source-commands)
|
||||
4. [Processing Commands](#processing-commands)
|
||||
5. [Data Selection & Filtering](#data-selection--filtering)
|
||||
6. [Aggregations & Statistics](#aggregations--statistics)
|
||||
7. [String Functions](#string-functions)
|
||||
8. [Mathematical Functions](#mathematical-functions)
|
||||
9. [Date/Time Functions](#datetime-functions)
|
||||
10. [Type Conversion Functions](#type-conversion-functions)
|
||||
11. [Conditional Functions](#conditional-functions)
|
||||
12. [Array Functions](#array-functions)
|
||||
13. [Join Operations (LOOKUP)](#join-operations-lookup)
|
||||
14. [Sorting & Limiting](#sorting--limiting)
|
||||
15. [Grouping & Aggregating](#grouping--aggregating)
|
||||
16. [Advanced Patterns](#advanced-patterns)
|
||||
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
ES|QL is Elasticsearch's new query language designed for data exploration, analysis, and transformation. It uses a pipe (`|`) syntax to chain commands together.
|
||||
|
||||
**Basic Syntax:**
|
||||
```
|
||||
FROM <data-source>
|
||||
| <processing-command>
|
||||
| <processing-command>
|
||||
| ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Basic Query Structure
|
||||
|
||||
### Simple Query
|
||||
```esql
|
||||
FROM logs-*
|
||||
| LIMIT 10
|
||||
```
|
||||
|
||||
### Query with Multiple Commands
|
||||
```esql
|
||||
FROM employees
|
||||
| WHERE department == "Engineering"
|
||||
| KEEP name, salary, hire_date
|
||||
| SORT salary DESC
|
||||
| LIMIT 5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Source Commands
|
||||
|
||||
### FROM - Specify Data Source
|
||||
```esql
|
||||
// From a single index
|
||||
FROM logs-2024
|
||||
|
||||
// From multiple indices with wildcard
|
||||
FROM logs-*, metrics-*
|
||||
|
||||
// From specific indices
|
||||
FROM index1, index2, index3
|
||||
|
||||
// With metadata
|
||||
FROM logs-* METADATA _id, _index
|
||||
```
|
||||
|
||||
### ROW - Generate Inline Data
|
||||
```esql
|
||||
// Create a single row
|
||||
ROW name = "John", age = 30, city = "NYC"
|
||||
|
||||
// Multiple rows
|
||||
ROW a = 1, b = "x"
|
||||
| EVAL c = a * 10
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Processing Commands
|
||||
|
||||
### KEEP - Select Specific Fields
|
||||
```esql
|
||||
FROM employees
|
||||
| KEEP name, department, salary
|
||||
|
||||
// Keep with pattern
|
||||
FROM logs-*
|
||||
| KEEP @timestamp, message, host.*
|
||||
```
|
||||
|
||||
### DROP - Remove Specific Fields
|
||||
```esql
|
||||
FROM employees
|
||||
| DROP password, ssn, internal_notes
|
||||
|
||||
// Drop with pattern
|
||||
FROM logs-*
|
||||
| DROP *.keyword
|
||||
```
|
||||
|
||||
### RENAME - Rename Fields
|
||||
```esql
|
||||
FROM employees
|
||||
| RENAME emp_name AS name, emp_dept AS department
|
||||
|
||||
// Multiple renames
|
||||
FROM logs-*
|
||||
| RENAME source.ip AS src_ip, destination.ip AS dst_ip
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Data Selection & Filtering
|
||||
|
||||
### WHERE - Filter Rows
|
||||
```esql
|
||||
// Equality
|
||||
FROM employees
|
||||
| WHERE department == "Sales"
|
||||
|
||||
// Comparison operators
|
||||
FROM products
|
||||
| WHERE price > 100 AND stock < 50
|
||||
|
||||
// IS NULL / IS NOT NULL
|
||||
FROM logs-*
|
||||
| WHERE error_code IS NOT NULL
|
||||
|
||||
// IN operator
|
||||
FROM employees
|
||||
| WHERE department IN ("Sales", "Marketing", "HR")
|
||||
|
||||
// LIKE operator (wildcards)
|
||||
FROM logs-*
|
||||
| WHERE message LIKE "*error*"
|
||||
|
||||
// RLIKE operator (regex)
|
||||
FROM logs-*
|
||||
| WHERE message RLIKE "error|exception|failure"
|
||||
|
||||
// NOT operator
|
||||
FROM employees
|
||||
| WHERE NOT department == "IT"
|
||||
|
||||
// Multiple conditions
|
||||
FROM orders
|
||||
| WHERE status == "completed"
|
||||
AND total_amount > 1000
|
||||
AND order_date >= "2024-01-01"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Aggregations & Statistics
|
||||
|
||||
### STATS - Aggregate Functions
|
||||
|
||||
#### COUNT
|
||||
```esql
|
||||
// Count all rows
|
||||
FROM logs-*
|
||||
| STATS count = COUNT()
|
||||
|
||||
// Count distinct
|
||||
FROM employees
|
||||
| STATS unique_departments = COUNT_DISTINCT(department)
|
||||
|
||||
// Count by group
|
||||
FROM logs-*
|
||||
| STATS event_count = COUNT() BY log_level
|
||||
```
|
||||
|
||||
#### SUM, AVG, MIN, MAX
|
||||
```esql
|
||||
FROM sales
|
||||
| STATS
|
||||
total_revenue = SUM(amount),
|
||||
avg_sale = AVG(amount),
|
||||
min_sale = MIN(amount),
|
||||
max_sale = MAX(amount)
|
||||
|
||||
// With grouping
|
||||
FROM sales
|
||||
| STATS
|
||||
total = SUM(amount),
|
||||
average = AVG(amount)
|
||||
BY product_category
|
||||
```
|
||||
|
||||
#### MEDIAN, PERCENTILE
|
||||
```esql
|
||||
FROM response_times
|
||||
| STATS
|
||||
median_time = MEDIAN(duration),
|
||||
p95 = PERCENTILE(duration, 95),
|
||||
p99 = PERCENTILE(duration, 99)
|
||||
```
|
||||
|
||||
#### Multiple Aggregations
|
||||
```esql
|
||||
FROM orders
|
||||
| STATS
|
||||
order_count = COUNT(),
|
||||
total_revenue = SUM(amount),
|
||||
avg_order_value = AVG(amount),
|
||||
unique_customers = COUNT_DISTINCT(customer_id)
|
||||
BY region, product_category
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## String Functions
|
||||
|
||||
### CONCAT - Concatenate Strings
|
||||
```esql
|
||||
FROM employees
|
||||
| EVAL full_name = CONCAT(first_name, " ", last_name)
|
||||
|
||||
// With separator
|
||||
FROM logs-*
|
||||
| EVAL log_info = CONCAT(level, ": ", message)
|
||||
```
|
||||
|
||||
### SUBSTRING - Extract Substring
|
||||
```esql
|
||||
FROM employees
|
||||
| EVAL first_initial = SUBSTRING(first_name, 0, 1)
|
||||
|
||||
// Extract with length
|
||||
FROM products
|
||||
| EVAL short_code = SUBSTRING(product_id, 0, 5)
|
||||
```
|
||||
|
||||
### LENGTH - String Length
|
||||
```esql
|
||||
FROM messages
|
||||
| EVAL message_length = LENGTH(message)
|
||||
| WHERE message_length > 100
|
||||
```
|
||||
|
||||
### TRIM, LTRIM, RTRIM - Remove Whitespace
|
||||
```esql
|
||||
FROM user_input
|
||||
| EVAL cleaned = TRIM(input_field)
|
||||
| EVAL left_trimmed = LTRIM(input_field)
|
||||
| EVAL right_trimmed = RTRIM(input_field)
|
||||
```
|
||||
|
||||
### UPPER, LOWER - Case Conversion
|
||||
```esql
|
||||
FROM employees
|
||||
| EVAL name_upper = UPPER(name)
|
||||
| EVAL email_lower = LOWER(email)
|
||||
```
|
||||
|
||||
### REPLACE - Replace String
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL cleaned_message = REPLACE(message, "ERROR", "Warning")
|
||||
```
|
||||
|
||||
### SPLIT - Split String into Array
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL tags_array = SPLIT(tags, ",")
|
||||
```
|
||||
|
||||
### STARTS_WITH, ENDS_WITH
|
||||
```esql
|
||||
FROM files
|
||||
| WHERE STARTS_WITH(filename, "log_")
|
||||
| WHERE ENDS_WITH(filename, ".txt")
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Mathematical Functions
|
||||
|
||||
### Basic Operations
|
||||
```esql
|
||||
FROM sales
|
||||
| EVAL
|
||||
total = price * quantity,
|
||||
discount_price = price * 0.9,
|
||||
tax = price * 0.08
|
||||
|
||||
// Multiple operations
|
||||
FROM metrics
|
||||
| EVAL
|
||||
sum_val = field1 + field2,
|
||||
diff_val = field1 - field2,
|
||||
product = field1 * field2,
|
||||
ratio = field1 / field2,
|
||||
remainder = field1 % field2
|
||||
```
|
||||
|
||||
### ABS - Absolute Value
|
||||
```esql
|
||||
FROM transactions
|
||||
| EVAL abs_amount = ABS(transaction_amount)
|
||||
```
|
||||
|
||||
### ROUND, FLOOR, CEIL
|
||||
```esql
|
||||
FROM measurements
|
||||
| EVAL
|
||||
rounded = ROUND(value, 2),
|
||||
floored = FLOOR(value),
|
||||
ceiled = CEIL(value)
|
||||
```
|
||||
|
||||
### POW - Power
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL squared = POW(value, 2)
|
||||
| EVAL cubed = POW(value, 3)
|
||||
```
|
||||
|
||||
### SQRT - Square Root
|
||||
```esql
|
||||
FROM measurements
|
||||
| EVAL sqrt_value = SQRT(value)
|
||||
```
|
||||
|
||||
### LOG, LOG10
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL
|
||||
natural_log = LOG(value),
|
||||
log_base_10 = LOG10(value)
|
||||
```
|
||||
|
||||
### GREATEST, LEAST
|
||||
```esql
|
||||
FROM comparisons
|
||||
| EVAL
|
||||
max_val = GREATEST(val1, val2, val3),
|
||||
min_val = LEAST(val1, val2, val3)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Date/Time Functions
|
||||
|
||||
### NOW - Current Timestamp
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL current_time = NOW()
|
||||
```
|
||||
|
||||
### DATE_EXTRACT - Extract Date Parts
|
||||
```esql
|
||||
FROM events
|
||||
| EVAL
|
||||
year = DATE_EXTRACT("year", @timestamp),
|
||||
month = DATE_EXTRACT("month", @timestamp),
|
||||
day = DATE_EXTRACT("day", @timestamp),
|
||||
hour = DATE_EXTRACT("hour", @timestamp),
|
||||
minute = DATE_EXTRACT("minute", @timestamp),
|
||||
day_of_week = DATE_EXTRACT("day_of_week", @timestamp)
|
||||
```
|
||||
|
||||
### DATE_FORMAT - Format Date
|
||||
```esql
|
||||
FROM events
|
||||
| EVAL formatted_date = DATE_FORMAT("yyyy-MM-dd", @timestamp)
|
||||
| EVAL custom_format = DATE_FORMAT("MMM dd, yyyy HH:mm", @timestamp)
|
||||
```
|
||||
|
||||
### DATE_TRUNC - Truncate Date
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL
|
||||
hour_bucket = DATE_TRUNC("hour", @timestamp),
|
||||
day_bucket = DATE_TRUNC("day", @timestamp),
|
||||
month_bucket = DATE_TRUNC("month", @timestamp)
|
||||
```
|
||||
|
||||
### DATE_DIFF - Date Difference
|
||||
```esql
|
||||
FROM orders
|
||||
| EVAL days_since_order = DATE_DIFF("days", order_date, NOW())
|
||||
| EVAL hours_to_delivery = DATE_DIFF("hours", order_date, delivery_date)
|
||||
```
|
||||
|
||||
### DATE_PARSE - Parse String to Date
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL parsed_date = DATE_PARSE("yyyy-MM-dd", date_string)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Type Conversion Functions
|
||||
|
||||
### TO_STRING - Convert to String
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL id_string = TO_STRING(id)
|
||||
| EVAL amount_string = TO_STRING(amount)
|
||||
```
|
||||
|
||||
### TO_INTEGER, TO_LONG - Convert to Integer
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL age_int = TO_INTEGER(age_string)
|
||||
| EVAL id_long = TO_LONG(id_string)
|
||||
```
|
||||
|
||||
### TO_DOUBLE - Convert to Double
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL price_double = TO_DOUBLE(price_string)
|
||||
```
|
||||
|
||||
### TO_BOOLEAN - Convert to Boolean
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL is_active = TO_BOOLEAN(active_string)
|
||||
```
|
||||
|
||||
### TO_DATETIME - Convert to DateTime
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL timestamp = TO_DATETIME(date_string)
|
||||
```
|
||||
|
||||
### TO_IP - Convert to IP Address
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL ip_address = TO_IP(ip_string)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Conditional Functions
|
||||
|
||||
### CASE - Conditional Logic
|
||||
```esql
|
||||
FROM employees
|
||||
| EVAL salary_grade = CASE(
|
||||
salary < 50000, "Entry",
|
||||
salary < 80000, "Mid",
|
||||
salary < 120000, "Senior",
|
||||
"Executive"
|
||||
)
|
||||
|
||||
// With multiple conditions
|
||||
FROM orders
|
||||
| EVAL order_status = CASE(
|
||||
status == "pending" AND days_old > 7, "Overdue",
|
||||
status == "pending", "Processing",
|
||||
status == "shipped", "In Transit",
|
||||
status == "delivered", "Completed",
|
||||
"Unknown"
|
||||
)
|
||||
```
|
||||
|
||||
### COALESCE - Return First Non-Null Value
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL display_name = COALESCE(nickname, first_name, username, "Unknown")
|
||||
```
|
||||
|
||||
### IF - Simple Conditional
|
||||
```esql
|
||||
FROM products
|
||||
| EVAL stock_status =
|
||||
CASE(stock > 0, "Available", "Out of Stock")
|
||||
|
||||
// Nested conditions
|
||||
FROM employees
|
||||
| EVAL bonus = CASE(
|
||||
performance_rating >= 4.5, salary * 0.15,
|
||||
performance_rating >= 3.5, salary * 0.10,
|
||||
performance_rating >= 2.5, salary * 0.05,
|
||||
0
|
||||
)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Array Functions
|
||||
|
||||
### MV_COUNT - Count Array Elements
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL tag_count = MV_COUNT(tags)
|
||||
| WHERE tag_count > 3
|
||||
```
|
||||
|
||||
### MV_AVG, MV_SUM, MV_MIN, MV_MAX - Array Aggregations
|
||||
```esql
|
||||
FROM metrics
|
||||
| EVAL
|
||||
avg_value = MV_AVG(values),
|
||||
total = MV_SUM(values),
|
||||
min_value = MV_MIN(values),
|
||||
max_value = MV_MAX(values)
|
||||
```
|
||||
|
||||
### MV_CONCAT - Concatenate Array Elements
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL all_tags = MV_CONCAT(tags, ", ")
|
||||
```
|
||||
|
||||
### MV_DEDUPE - Remove Duplicates from Array
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL unique_values = MV_DEDUPE(values)
|
||||
```
|
||||
|
||||
### MV_FIRST, MV_LAST - Get First/Last Element
|
||||
```esql
|
||||
FROM logs-*
|
||||
| EVAL first_tag = MV_FIRST(tags)
|
||||
| EVAL last_tag = MV_LAST(tags)
|
||||
```
|
||||
|
||||
### MV_SLICE - Extract Array Slice
|
||||
```esql
|
||||
FROM data
|
||||
| EVAL first_three = MV_SLICE(values, 0, 3)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Join Operations (LOOKUP)
|
||||
|
||||
ES|QL uses ENRICH (similar to LOOKUP/JOIN) to join data from enrich policies.
|
||||
|
||||
### Prerequisites: Create Enrich Policy
|
||||
First, create an enrich policy in Kibana Dev Tools:
|
||||
|
||||
```json
|
||||
PUT /_enrich/policy/user_lookup
|
||||
{
|
||||
"match": {
|
||||
"indices": "users",
|
||||
"match_field": "user_id",
|
||||
"enrich_fields": ["username", "email", "department"]
|
||||
}
|
||||
}
|
||||
|
||||
POST /_enrich/policy/user_lookup/_execute
|
||||
```
|
||||
|
||||
### ENRICH - Join/Lookup Data
|
||||
```esql
|
||||
FROM logs-*
|
||||
| ENRICH user_lookup ON user_id
|
||||
| KEEP @timestamp, user_id, username, email, message
|
||||
|
||||
// With field renaming
|
||||
FROM transactions
|
||||
| ENRICH product_lookup ON product_id WITH product_name, category, price
|
||||
| KEEP transaction_id, product_name, category, quantity, price
|
||||
|
||||
// Multiple enrichments
|
||||
FROM orders
|
||||
| ENRICH customer_lookup ON customer_id WITH customer_name, customer_tier
|
||||
| ENRICH product_lookup ON product_id WITH product_name, product_category
|
||||
| KEEP order_id, customer_name, product_name, order_amount
|
||||
```
|
||||
|
||||
### Complex Join Example
|
||||
```esql
|
||||
FROM orders
|
||||
| ENRICH customer_lookup ON customer_id
|
||||
WITH customer_name, customer_email, customer_segment
|
||||
| ENRICH product_lookup ON product_id
|
||||
WITH product_name, product_category, product_price
|
||||
| EVAL total_price = quantity * product_price
|
||||
| WHERE customer_segment == "Premium"
|
||||
| STATS
|
||||
total_orders = COUNT(),
|
||||
total_revenue = SUM(total_price)
|
||||
BY customer_name, product_category
|
||||
| SORT total_revenue DESC
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Sorting & Limiting
|
||||
|
||||
### SORT - Order Results
|
||||
```esql
|
||||
// Ascending order (default)
|
||||
FROM employees
|
||||
| SORT salary
|
||||
|
||||
// Descending order
|
||||
FROM employees
|
||||
| SORT salary DESC
|
||||
|
||||
// Multiple fields
|
||||
FROM employees
|
||||
| SORT department ASC, salary DESC
|
||||
|
||||
// With nulls first/last
|
||||
FROM data
|
||||
| SORT value DESC NULLS FIRST
|
||||
```
|
||||
|
||||
### LIMIT - Limit Results
|
||||
```esql
|
||||
// Get first 10 rows
|
||||
FROM logs-*
|
||||
| LIMIT 10
|
||||
|
||||
// Top 5 highest salaries
|
||||
FROM employees
|
||||
| SORT salary DESC
|
||||
| LIMIT 5
|
||||
|
||||
// Pagination (skip and limit)
|
||||
FROM products
|
||||
| SORT price
|
||||
| LIMIT 20 // Results 0-19
|
||||
```
|
||||
|
||||
### HEAD - Get First N Rows (Alias for LIMIT)
|
||||
```esql
|
||||
FROM logs-*
|
||||
| HEAD 100
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Grouping & Aggregating
|
||||
|
||||
### GROUP BY with STATS
|
||||
```esql
|
||||
// Single field grouping
|
||||
FROM sales
|
||||
| STATS total_sales = SUM(amount) BY region
|
||||
|
||||
// Multiple field grouping
|
||||
FROM orders
|
||||
| STATS
|
||||
order_count = COUNT(),
|
||||
total_revenue = SUM(amount)
|
||||
BY region, product_category, sales_rep
|
||||
|
||||
// Time-based grouping
|
||||
FROM logs-*
|
||||
| EVAL hour = DATE_TRUNC("hour", @timestamp)
|
||||
| STATS event_count = COUNT() BY hour, log_level
|
||||
| SORT hour DESC
|
||||
```
|
||||
|
||||
### Complex Aggregation Example
|
||||
```esql
|
||||
FROM sales_data
|
||||
| WHERE order_date >= "2024-01-01"
|
||||
| EVAL month = DATE_TRUNC("month", order_date)
|
||||
| STATS
|
||||
total_orders = COUNT(),
|
||||
total_revenue = SUM(amount),
|
||||
avg_order_value = AVG(amount),
|
||||
unique_customers = COUNT_DISTINCT(customer_id),
|
||||
max_order = MAX(amount),
|
||||
min_order = MIN(amount)
|
||||
BY month, region, product_category
|
||||
| EVAL revenue_per_customer = total_revenue / unique_customers
|
||||
| WHERE total_orders > 100
|
||||
| SORT month DESC, total_revenue DESC
|
||||
| LIMIT 50
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Advanced Patterns
|
||||
|
||||
### Window Functions Pattern
|
||||
```esql
|
||||
// Running total by group
|
||||
FROM sales
|
||||
| SORT date
|
||||
| STATS
|
||||
daily_sales = SUM(amount),
|
||||
order_count = COUNT()
|
||||
BY date, region
|
||||
| SORT region, date
|
||||
```
|
||||
|
||||
### Pivoting Data
|
||||
```esql
|
||||
// Count by status and priority
|
||||
FROM tickets
|
||||
| STATS ticket_count = COUNT() BY status, priority
|
||||
| SORT status, priority
|
||||
```
|
||||
|
||||
### Finding Duplicates
|
||||
```esql
|
||||
FROM users
|
||||
| STATS count = COUNT() BY email
|
||||
| WHERE count > 1
|
||||
| SORT count DESC
|
||||
```
|
||||
|
||||
### Time Series Analysis
|
||||
```esql
|
||||
FROM metrics-*
|
||||
| EVAL
|
||||
hour = DATE_TRUNC("hour", @timestamp),
|
||||
day = DATE_EXTRACT("day", @timestamp)
|
||||
| STATS
|
||||
avg_cpu = AVG(cpu_percent),
|
||||
max_cpu = MAX(cpu_percent),
|
||||
avg_memory = AVG(memory_percent)
|
||||
BY hour, host
|
||||
| WHERE avg_cpu > 80
|
||||
| SORT hour DESC
|
||||
```
|
||||
|
||||
### Percentage Calculations
|
||||
```esql
|
||||
FROM sales
|
||||
| STATS
|
||||
total_sales = SUM(amount),
|
||||
count = COUNT()
|
||||
BY product_category
|
||||
| EVAL percentage = ROUND(total_sales / SUM(total_sales) * 100, 2)
|
||||
| SORT percentage DESC
|
||||
```
|
||||
|
||||
### Top N per Group
|
||||
```esql
|
||||
// Top 3 products per category by sales
|
||||
FROM sales
|
||||
| STATS total_sales = SUM(amount) BY product_category, product_name
|
||||
| SORT product_category, total_sales DESC
|
||||
// Note: ES|QL doesn't have native PARTITION BY,
|
||||
// so you may need to process this in multiple queries or use aggregations
|
||||
```
|
||||
|
||||
### Data Cleaning
|
||||
```esql
|
||||
FROM raw_data
|
||||
| EVAL
|
||||
// Clean whitespace
|
||||
cleaned_name = TRIM(name),
|
||||
// Standardize case
|
||||
email_lower = LOWER(email),
|
||||
// Replace values
|
||||
status = REPLACE(status, "N/A", "Unknown"),
|
||||
// Handle nulls
|
||||
age = COALESCE(age, 0),
|
||||
// Validate ranges
|
||||
valid_age = CASE(age < 0 OR age > 150, NULL, age)
|
||||
| WHERE cleaned_name IS NOT NULL
|
||||
| DROP name, email
|
||||
| RENAME cleaned_name AS name, email_lower AS email
|
||||
```
|
||||
|
||||
### Cohort Analysis
|
||||
```esql
|
||||
FROM user_events
|
||||
| EVAL
|
||||
signup_month = DATE_TRUNC("month", signup_date),
|
||||
event_month = DATE_TRUNC("month", event_date)
|
||||
| STATS
|
||||
active_users = COUNT_DISTINCT(user_id)
|
||||
BY signup_month, event_month
|
||||
| SORT signup_month, event_month
|
||||
```
|
||||
|
||||
### Anomaly Detection Pattern
|
||||
```esql
|
||||
FROM metrics-*
|
||||
| EVAL hour = DATE_TRUNC("hour", @timestamp)
|
||||
| STATS
|
||||
avg_value = AVG(value),
|
||||
stddev = SQRT(AVG(POW(value - AVG(value), 2)))
|
||||
BY hour
|
||||
| EVAL
|
||||
upper_bound = avg_value + (2 * stddev),
|
||||
lower_bound = avg_value - (2 * stddev)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Complete Real-World Examples
|
||||
|
||||
### Example 1: User Activity Dashboard
|
||||
```esql
|
||||
FROM user_logs-*
|
||||
| WHERE @timestamp >= NOW() - 7 days
|
||||
| ENRICH user_lookup ON user_id WITH username, user_tier
|
||||
| EVAL day = DATE_TRUNC("day", @timestamp)
|
||||
| STATS
|
||||
daily_active_users = COUNT_DISTINCT(user_id),
|
||||
total_sessions = COUNT(),
|
||||
avg_session_duration = AVG(session_duration)
|
||||
BY day, user_tier
|
||||
| EVAL avg_duration_minutes = ROUND(avg_session_duration / 60, 2)
|
||||
| SORT day DESC, user_tier
|
||||
```
|
||||
|
||||
### Example 2: E-commerce Sales Report
|
||||
```esql
|
||||
FROM orders
|
||||
| WHERE order_date >= "2024-01-01"
|
||||
| ENRICH customer_lookup ON customer_id
|
||||
WITH customer_name, customer_segment
|
||||
| ENRICH product_lookup ON product_id
|
||||
WITH product_name, product_category, cost_price
|
||||
| EVAL
|
||||
profit = (price - cost_price) * quantity,
|
||||
month = DATE_TRUNC("month", order_date)
|
||||
| STATS
|
||||
total_orders = COUNT(),
|
||||
total_revenue = SUM(price * quantity),
|
||||
total_profit = SUM(profit),
|
||||
avg_order_value = AVG(price * quantity),
|
||||
unique_customers = COUNT_DISTINCT(customer_id)
|
||||
BY month, product_category, customer_segment
|
||||
| EVAL profit_margin = ROUND(total_profit / total_revenue * 100, 2)
|
||||
| WHERE total_revenue > 10000
|
||||
| SORT month DESC, total_revenue DESC
|
||||
| LIMIT 100
|
||||
```
|
||||
|
||||
### Example 3: Security Log Analysis
|
||||
```esql
|
||||
FROM security-logs-*
|
||||
| WHERE @timestamp >= NOW() - 24 hours
|
||||
| WHERE event_type IN ("login_failed", "suspicious_activity")
|
||||
| EVAL hour = DATE_TRUNC("hour", @timestamp)
|
||||
| STATS
|
||||
event_count = COUNT(),
|
||||
unique_ips = COUNT_DISTINCT(source_ip),
|
||||
unique_users = COUNT_DISTINCT(username)
|
||||
BY hour, event_type, country
|
||||
| WHERE event_count > 100
|
||||
| SORT hour DESC, event_count DESC
|
||||
```
|
||||
|
||||
### Example 4: Application Performance Monitoring
|
||||
```esql
|
||||
FROM apm-*
|
||||
| WHERE @timestamp >= NOW() - 1 hour
|
||||
| EVAL
|
||||
response_category = CASE(
|
||||
response_time < 100, "Fast",
|
||||
response_time < 500, "Medium",
|
||||
response_time < 1000, "Slow",
|
||||
"Very Slow"
|
||||
),
|
||||
minute = DATE_TRUNC("minute", @timestamp)
|
||||
| STATS
|
||||
request_count = COUNT(),
|
||||
avg_response = AVG(response_time),
|
||||
p95_response = PERCENTILE(response_time, 95),
|
||||
p99_response = PERCENTILE(response_time, 99),
|
||||
error_count = COUNT() WHERE status_code >= 400
|
||||
BY minute, endpoint, response_category
|
||||
| EVAL error_rate = ROUND(error_count / request_count * 100, 2)
|
||||
| WHERE request_count > 10
|
||||
| SORT minute DESC, avg_response DESC
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Tips & Best Practices
|
||||
|
||||
1. **Use KEEP instead of SELECT** - More explicit about which fields to retain
|
||||
2. **Filter early with WHERE** - Reduce data processing by filtering before aggregations
|
||||
3. **Use DATE_TRUNC for time bucketing** - Essential for time series analysis
|
||||
4. **Leverage ENRICH for joins** - Pre-create enrich policies for frequently joined data
|
||||
5. **Use EVAL for calculated fields** - Create derived fields before aggregation
|
||||
6. **Combine multiple conditions in WHERE** - More efficient than multiple WHERE clauses
|
||||
7. **Use STATS with BY for grouping** - Replaces traditional GROUP BY
|
||||
8. **Sort after aggregation** - More efficient than sorting before
|
||||
9. **Use LIMIT to control output size** - Especially important for large datasets
|
||||
10. **Use metadata fields when needed** - Access _id, _index with METADATA keyword
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns Cheat Sheet
|
||||
|
||||
```esql
|
||||
// Count by field
|
||||
FROM index | STATS count = COUNT() BY field
|
||||
|
||||
// Top N
|
||||
FROM index | STATS value = SUM(amount) BY category | SORT value DESC | LIMIT 10
|
||||
|
||||
// Time series
|
||||
FROM index | EVAL bucket = DATE_TRUNC("hour", @timestamp) | STATS count = COUNT() BY bucket
|
||||
|
||||
// Percentage of total
|
||||
FROM index | STATS total = SUM(amount) BY category | EVAL pct = total / SUM(total) * 100
|
||||
|
||||
// Filter nulls
|
||||
FROM index | WHERE field IS NOT NULL
|
||||
|
||||
// String matching
|
||||
FROM index | WHERE field LIKE "*pattern*"
|
||||
|
||||
// Date range
|
||||
FROM index | WHERE @timestamp >= NOW() - 7 days
|
||||
|
||||
// Multiple aggregations
|
||||
FROM index | STATS count = COUNT(), sum = SUM(val), avg = AVG(val) BY group
|
||||
|
||||
// Conditional aggregation
|
||||
FROM index | STATS error_count = COUNT() WHERE status == "error" BY service
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Comparison with Traditional SQL
|
||||
|
||||
| SQL | ES|QL |
|
||||
|-----|-------|
|
||||
| SELECT * | FROM index |
|
||||
| SELECT field1, field2 | FROM index \| KEEP field1, field2 |
|
||||
| WHERE condition | WHERE condition (same) |
|
||||
| GROUP BY field | STATS ... BY field |
|
||||
| ORDER BY field | SORT field |
|
||||
| LIMIT 10 | LIMIT 10 (same) |
|
||||
| COUNT(*) | STATS count = COUNT() |
|
||||
| SUM(field) | STATS total = SUM(field) |
|
||||
| AVG(field) | STATS avg = AVG(field) |
|
||||
| JOIN | ENRICH (using enrich policies) |
|
||||
| CASE WHEN | CASE(...) |
|
||||
| CONCAT(a, b) | CONCAT(a, b) (same) |
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
- Official ES|QL Documentation: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
|
||||
- ES|QL Functions Reference: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-functions.html
|
||||
- Enrich Processor: https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html
|
||||
|
||||
---
|
||||
|
||||
*Last Updated: 2024*
|
||||
*ES|QL is actively evolving - check official documentation for latest features*
|
||||
17
cmd/node.go
17
cmd/node.go
@@ -36,7 +36,6 @@ func Node(conf *cfg.Config) *cli.Command {
|
||||
NodeList(conf),
|
||||
NodeShow(conf),
|
||||
NodeClients(conf),
|
||||
NodeUsage(conf),
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -104,19 +103,3 @@ func NodeClients(conf *cfg.Config) *cli.Command {
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func NodeUsage(conf *cfg.Config) *cli.Command {
|
||||
return &cli.Command{
|
||||
Name: "usage",
|
||||
Usage: "show node usage stats",
|
||||
UsageText: "usage [options] [<node>]",
|
||||
|
||||
ShellComplete: func(ctx context.Context, cmd *cli.Command) {
|
||||
complete(conf, cmd, Cnode)
|
||||
},
|
||||
|
||||
Action: func(ctx context.Context, cmd *cli.Command) error {
|
||||
return es.NodeUsage(conf, cmd.Args().Get(0))
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
36
cmd/root.go
36
cmd/root.go
@@ -21,17 +21,13 @@ import (
|
||||
"fmt"
|
||||
golog "log"
|
||||
"os"
|
||||
"runtime/debug"
|
||||
"runtime/pprof"
|
||||
"strings"
|
||||
|
||||
"codeberg.org/scip/esctl/assets"
|
||||
"codeberg.org/scip/esctl/pkg/cfg"
|
||||
"codeberg.org/scip/esctl/pkg/es"
|
||||
"codeberg.org/scip/esctl/pkg/log"
|
||||
"codeberg.org/scip/esctl/pkg/printer"
|
||||
|
||||
markdown "github.com/MichaelMure/go-term-markdown"
|
||||
"github.com/urfave/cli/v3"
|
||||
)
|
||||
|
||||
@@ -119,12 +115,6 @@ func Main() int {
|
||||
Usage: "enable HTTP debugging",
|
||||
Destination: &conf.DebugHTTP,
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "debug-goroutines",
|
||||
Value: false,
|
||||
Usage: "enable goroutine debugging",
|
||||
Destination: &conf.DebugGoRoutines,
|
||||
},
|
||||
&cli.BoolFlag{
|
||||
Name: "align-ints",
|
||||
Aliases: []string{"I"},
|
||||
@@ -151,7 +141,7 @@ func Main() int {
|
||||
Name: "output",
|
||||
Aliases: []string{"o"},
|
||||
Value: "",
|
||||
Usage: "output mode (tsv, csv, json, yaml) default: tsv",
|
||||
Usage: "output mode (tsv, json, yaml) default: tsv",
|
||||
Destination: &conf.Output,
|
||||
},
|
||||
&cli.StringFlag{
|
||||
@@ -174,7 +164,6 @@ func Main() int {
|
||||
Node(conf),
|
||||
Roles(conf),
|
||||
Search(conf),
|
||||
SearchQL(conf),
|
||||
Shard(conf),
|
||||
Snapshot(conf),
|
||||
Task(conf),
|
||||
@@ -182,7 +171,6 @@ func Main() int {
|
||||
Debug(conf),
|
||||
HelpJsonPath(conf),
|
||||
HelpUsage(conf),
|
||||
HelpEsQl(conf),
|
||||
},
|
||||
|
||||
Before: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {
|
||||
@@ -238,34 +226,12 @@ func HelpJsonPath(conf *cfg.Config) *cli.Command {
|
||||
}
|
||||
}
|
||||
|
||||
func HelpEsQl(conf *cfg.Config) *cli.Command {
|
||||
return &cli.Command{
|
||||
Name: "help-esql",
|
||||
Usage: "show esql help",
|
||||
|
||||
Action: func(ctx context.Context, cmd *cli.Command) error {
|
||||
assets.LoadEsql()
|
||||
|
||||
width := cfg.GetTermWidth()
|
||||
printer.Pager("esql cheat sheet", string(markdown.Render(assets.EsQlCheatSheet, width, cfg.DefaultMargin)))
|
||||
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func Version(conf *cfg.Config) *cli.Command {
|
||||
return &cli.Command{
|
||||
Name: "version",
|
||||
Usage: "show esctl version information",
|
||||
|
||||
Action: func(ctx context.Context, cmd *cli.Command) error {
|
||||
info, _ := debug.ReadBuildInfo()
|
||||
|
||||
if strings.Contains(info.Main.Version, "+dirty") {
|
||||
cfg.COMMIT += "+dirty"
|
||||
}
|
||||
|
||||
_, err := fmt.Printf(versionFmt,
|
||||
cfg.Version, cfg.BUILD, cfg.BRANCH, cfg.COMMIT, cfg.GOVERSION, cfg.APIVERSION)
|
||||
|
||||
|
||||
@@ -18,7 +18,6 @@ package cmd
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
|
||||
"codeberg.org/scip/esctl/pkg/cfg"
|
||||
"codeberg.org/scip/esctl/pkg/es"
|
||||
@@ -46,11 +45,6 @@ https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#dat
|
||||
For timestamp formats refer to:
|
||||
https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-date-format`
|
||||
|
||||
const QlUsage = `ES|QL documentation:
|
||||
https://www.elastic.co/docs/reference/query-languages/esql/esql-getting-started
|
||||
|
||||
See also: esctl help-esql`
|
||||
|
||||
func Search(conf *cfg.Config) *cli.Command {
|
||||
return &cli.Command{
|
||||
Name: "search",
|
||||
@@ -155,19 +149,3 @@ func Search(conf *cfg.Config) *cli.Command {
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func SearchQL(conf *cfg.Config) *cli.Command {
|
||||
return &cli.Command{
|
||||
Name: "searchql",
|
||||
Aliases: []string{"/"},
|
||||
Usage: "search using ES/QL language",
|
||||
UsageText: "search <ES/QL term>",
|
||||
CustomHelpTemplate: addReference(QlUsage),
|
||||
|
||||
Action: func(ctx context.Context, cmd *cli.Command) error {
|
||||
args := cmd.Args()
|
||||
|
||||
return es.SearchQL(conf, strings.Join(args.Slice(), " "))
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
@@ -194,18 +194,18 @@ func (cluster *Cluster) getDefaultOptions() []elasticsearch.Option {
|
||||
}
|
||||
|
||||
func (cluster *Cluster) getTransport() elastictransport.Option {
|
||||
transport := new(http.Transport{
|
||||
transport := &http.Transport{
|
||||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
||||
})
|
||||
}
|
||||
|
||||
if cluster.DebugHTTP {
|
||||
return elastictransport.WithTransport(
|
||||
new(DebugTransport{Transport: transport}),
|
||||
&DebugTransport{Transport: transport},
|
||||
)
|
||||
}
|
||||
|
||||
return elastictransport.WithTransport(
|
||||
new(CompatibilityTransport{Transport: transport}),
|
||||
&CompatibilityTransport{Transport: transport},
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
Version string = `v0.0.27`
|
||||
Version string = `v0.0.26`
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -89,13 +89,12 @@ type Config struct {
|
||||
|
||||
Force bool // ccr follower renew: -f
|
||||
|
||||
DebugHTTP bool // root: --debug-http
|
||||
DebugGoRoutines bool // root: --debug-goroutines
|
||||
Separator string // role diff: -s
|
||||
NotDeployed bool // role diff: -n
|
||||
Undefined bool // role diff: -u
|
||||
Diff bool // role diff: -D
|
||||
Hidden bool // ds ls: -H
|
||||
DebugHTTP bool // root: --debug-http
|
||||
Separator string // role diff: -s
|
||||
NotDeployed bool // role diff: -n
|
||||
Undefined bool // role diff: -u
|
||||
Diff bool // role diff: -D
|
||||
Hidden bool // ds ls: -H
|
||||
|
||||
// rollover
|
||||
MaxAge string
|
||||
@@ -114,7 +113,7 @@ type Config struct {
|
||||
}
|
||||
|
||||
func NewConfig() *Config {
|
||||
return new(Config{Clusters: map[string]*Cluster{}})
|
||||
return &Config{Clusters: map[string]*Cluster{}}
|
||||
}
|
||||
|
||||
func getDefaultPath() string {
|
||||
@@ -217,7 +216,7 @@ func (conf *Config) LoadConfig() error {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
newconf := new(Config{})
|
||||
newconf := &Config{}
|
||||
|
||||
err = yaml.Unmarshal(data, newconf)
|
||||
if err != nil {
|
||||
|
||||
@@ -28,7 +28,6 @@ import (
|
||||
"io"
|
||||
"log"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net/http"
|
||||
"os"
|
||||
"os/exec"
|
||||
@@ -159,7 +158,7 @@ func ApiRepl(conf *cfg.Config) error {
|
||||
}
|
||||
|
||||
func pageJsonOutput(conf *cfg.Config, raw []byte) {
|
||||
tmpconf := new(cfg.Config{HaveJQ: conf.HaveJQ})
|
||||
tmpconf := &cfg.Config{HaveJQ: conf.HaveJQ}
|
||||
|
||||
if conf.Pager != "" {
|
||||
tmpconf.HaveJQ = false
|
||||
@@ -207,16 +206,16 @@ func CallAPI(conf *cfg.Config, verb, path, data string) ([]byte, error) {
|
||||
verb = strings.ToUpper(verb)
|
||||
|
||||
// we're using port-forwards anyway
|
||||
noVerifyTransport := new(http.Transport{
|
||||
TLSClientConfig: new(tls.Config{InsecureSkipVerify: true}),
|
||||
})
|
||||
noVerifyTransport := &http.Transport{
|
||||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
||||
}
|
||||
|
||||
client := new(http.Client{Transport: noVerifyTransport})
|
||||
client := &http.Client{Transport: noVerifyTransport}
|
||||
|
||||
if conf.DebugHTTP {
|
||||
client = new(http.Client{
|
||||
Transport: new(cfg.DebugTransport{
|
||||
Transport: noVerifyTransport})})
|
||||
client = &http.Client{
|
||||
Transport: &cfg.DebugTransport{
|
||||
Transport: noVerifyTransport}}
|
||||
}
|
||||
|
||||
req, err := http.NewRequest(verb, conf.DefaultCluster.Uri+path, bytes.NewBuffer([]byte(data)))
|
||||
@@ -224,7 +223,7 @@ func CallAPI(conf *cfg.Config, verb, path, data string) ([]byte, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if !conf.HumanCat || (conf.HumanCat && !strings.HasPrefix(path, "/_cat")) {
|
||||
if !conf.HumanCat && strings.HasPrefix(path, "/_cat") {
|
||||
req.Header.Add("Content-Type", "application/json")
|
||||
req.Header.Add("Accept", "application/json")
|
||||
}
|
||||
@@ -281,8 +280,7 @@ func prettyfiJson(conf *cfg.Config, raw []byte) (string, error) {
|
||||
|
||||
err := json.Indent(&pretty, raw, "", "\t")
|
||||
if err != nil {
|
||||
//nolint:nilerr
|
||||
return string(raw), nil
|
||||
return "", fmt.Errorf("json parse error: %w", err)
|
||||
}
|
||||
|
||||
return pretty.String(), nil
|
||||
@@ -367,7 +365,16 @@ func ApiList(conf *cfg.Config, pattern string) error {
|
||||
func ApiPathNames() []string {
|
||||
assets.LoadAssetOpenApi()
|
||||
|
||||
return slices.Collect(maps.Keys(assets.OpenAPI.Spec().Paths.Paths))
|
||||
paths := make([]string, len(assets.OpenAPI.Spec().Paths.Paths))
|
||||
|
||||
idx := 0
|
||||
|
||||
for path := range assets.OpenAPI.Spec().Paths.Paths {
|
||||
paths[idx] = path
|
||||
idx++
|
||||
}
|
||||
|
||||
return paths
|
||||
}
|
||||
|
||||
func ApiShow(conf *cfg.Config, showpath, verb string) error {
|
||||
@@ -528,7 +535,7 @@ func getApiExample(op *Op) string {
|
||||
// otherwise showpath+verb have to match precisely.
|
||||
func matchOperation(showpath, verb string) (*Op, error) {
|
||||
ops := []*Op{}
|
||||
op := new(Op{})
|
||||
op := &Op{}
|
||||
|
||||
var found bool
|
||||
|
||||
|
||||
@@ -17,10 +17,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
package es
|
||||
|
||||
import (
|
||||
|
||||
// "encoding/json/jsontext"
|
||||
// "encoding/json/v2"
|
||||
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
@@ -53,22 +49,11 @@ func getHealthReport(conf *cfg.Config) (*HealthReport, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
report := new(HealthReport{})
|
||||
|
||||
// FIXME: use this once jsonv2 is no more experimental it already
|
||||
// builds and works like intended, but golangci-lint doesn't
|
||||
// recognize it with: go: unknown GOEXPERIMENT jsonv2
|
||||
//
|
||||
// if err := json.UnmarshalDecode(
|
||||
// jsontext.NewDecoder(
|
||||
// bytes.NewBuffer(raw)),
|
||||
// &report); err != nil {
|
||||
// return nil, fmt.Errorf("failed to unmarshal healthreport response: %w", err)
|
||||
// }
|
||||
report := HealthReport{}
|
||||
|
||||
if err := json.Unmarshal(raw, &report); err != nil {
|
||||
return nil, fmt.Errorf("failed to unmarshal healthreport response: %w", err)
|
||||
}
|
||||
|
||||
return report, nil
|
||||
return &report, nil
|
||||
}
|
||||
|
||||
@@ -101,39 +101,23 @@ func getClusterStatus(conf *cfg.Config) (*apiResponse, error) {
|
||||
es := conf.DefaultCluster.ES()
|
||||
|
||||
responses := make(chan apiResponse, gocount)
|
||||
wg := new(sync.WaitGroup{})
|
||||
wg := &sync.WaitGroup{}
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, es, responses, "health")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, es, responses, "healthreport")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, es, responses, "info")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, es, responses, "ccr")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, es, responses, "indices")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, es, responses, "tasks")
|
||||
})
|
||||
wg.Add(gocount)
|
||||
go getApiData(conf, es, wg, responses, "health")
|
||||
go getApiData(conf, es, wg, responses, "healthreport")
|
||||
go getApiData(conf, es, wg, responses, "info")
|
||||
go getApiData(conf, es, wg, responses, "ccr")
|
||||
go getApiData(conf, es, wg, responses, "indices")
|
||||
go getApiData(conf, es, wg, responses, "tasks")
|
||||
|
||||
if conf.Verbose {
|
||||
getApiData(conf, es, responses, "stats")
|
||||
go getApiData(conf, es, wg, responses, "stats")
|
||||
}
|
||||
|
||||
wg.Wait()
|
||||
|
||||
all := new(apiResponse{})
|
||||
all := apiResponse{}
|
||||
|
||||
var err error
|
||||
|
||||
@@ -160,7 +144,7 @@ func getClusterStatus(conf *cfg.Config) (*apiResponse, error) {
|
||||
}
|
||||
}
|
||||
|
||||
return all, err
|
||||
return &all, err
|
||||
}
|
||||
|
||||
func ClusterStatus(conf *cfg.Config) error {
|
||||
|
||||
@@ -29,12 +29,12 @@ func ClusterRerouteMove(conf *cfg.Config, index string) error {
|
||||
move := conf.DefaultCluster.ES().Cluster.Reroute()
|
||||
|
||||
commands := esdsl.NewCommand()
|
||||
moveCommand := new(types.CommandMoveAction{
|
||||
moveCommand := &types.CommandMoveAction{
|
||||
Shard: conf.Shards,
|
||||
FromNode: conf.FromNode,
|
||||
ToNode: conf.ToNode,
|
||||
Index: index,
|
||||
})
|
||||
}
|
||||
|
||||
commands.CommandCaster().Move = moveCommand
|
||||
|
||||
@@ -52,11 +52,11 @@ func ClusterRerouteAllocateReplica(conf *cfg.Config, index string) error {
|
||||
move := conf.DefaultCluster.ES().Cluster.Reroute()
|
||||
|
||||
commands := esdsl.NewCommand()
|
||||
allocCommand := new(types.CommandAllocateReplicaAction{
|
||||
allocCommand := &types.CommandAllocateReplicaAction{
|
||||
Shard: conf.Shards,
|
||||
Node: conf.ToNode,
|
||||
Index: index,
|
||||
})
|
||||
}
|
||||
|
||||
commands.CommandCaster().AllocateReplica = allocCommand
|
||||
|
||||
@@ -74,12 +74,12 @@ func ClusterRerouteCancel(conf *cfg.Config, index string) error {
|
||||
move := conf.DefaultCluster.ES().Cluster.Reroute()
|
||||
|
||||
commands := esdsl.NewCommand()
|
||||
cancelCommand := new(types.CommandCancelAction{
|
||||
cancelCommand := &types.CommandCancelAction{
|
||||
Shard: conf.Shards,
|
||||
Node: conf.ToNode,
|
||||
Index: index,
|
||||
AllowPrimary: &conf.AllowPrimary,
|
||||
})
|
||||
}
|
||||
|
||||
commands.CommandCaster().Cancel = cancelCommand
|
||||
|
||||
@@ -97,12 +97,12 @@ func ClusterRerouteAllocatePrimary(conf *cfg.Config, index string, stale bool) e
|
||||
move := conf.DefaultCluster.ES().Cluster.Reroute()
|
||||
|
||||
commands := esdsl.NewCommand()
|
||||
allocCommand := new(types.CommandAllocatePrimaryAction{
|
||||
allocCommand := &types.CommandAllocatePrimaryAction{
|
||||
Shard: conf.Shards,
|
||||
Node: conf.ToNode,
|
||||
Index: index,
|
||||
AcceptDataLoss: conf.AcceptDataLoss,
|
||||
})
|
||||
}
|
||||
|
||||
if stale {
|
||||
commands.CommandCaster().AllocateStalePrimary = allocCommand
|
||||
|
||||
@@ -101,7 +101,7 @@ func DocDelete(conf *cfg.Config, queries []string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
req := new(deletebyquery.Request{})
|
||||
req := &deletebyquery.Request{}
|
||||
|
||||
if len(queries) == 0 && conf.All {
|
||||
req.Query = esdsl.NewMatchAllQuery().QueryCaster()
|
||||
|
||||
@@ -22,8 +22,6 @@ import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"slices"
|
||||
"strings"
|
||||
|
||||
"codeberg.org/scip/esctl/pkg/cfg"
|
||||
@@ -64,7 +62,13 @@ func IlmNames(conf *cfg.Config) ([]string, error) {
|
||||
return nil, fmt.Errorf("failed to get ilm policies: %w", esErrorString(err))
|
||||
}
|
||||
|
||||
names := slices.Collect(maps.Keys(res))
|
||||
names := make([]string, len(res))
|
||||
idx := 0
|
||||
|
||||
for name := range res {
|
||||
names[idx] = name
|
||||
idx++
|
||||
}
|
||||
|
||||
return names, nil
|
||||
}
|
||||
@@ -347,7 +351,7 @@ func IlmCreate(conf *cfg.Config, policyname string) error {
|
||||
|
||||
var actions types.IlmActionsVariant = esdsl.NewIlmActions()
|
||||
|
||||
rollover := new(types.RolloverAction{})
|
||||
rollover := &types.RolloverAction{}
|
||||
haveroll := false
|
||||
|
||||
if policy != nil {
|
||||
@@ -509,8 +513,8 @@ func IlmCreate(conf *cfg.Config, policyname string) error {
|
||||
phases.PhasesCaster().Delete = policy.Phases.Delete
|
||||
}
|
||||
|
||||
put := new(putlifecycle.Request{})
|
||||
newpolicy := new(types.IlmPolicy{})
|
||||
put := &putlifecycle.Request{}
|
||||
newpolicy := &types.IlmPolicy{}
|
||||
newpolicy.IlmPolicyCaster().Phases = *phases.PhasesCaster()
|
||||
put.Policy = newpolicy
|
||||
|
||||
|
||||
@@ -185,19 +185,12 @@ func virtualAge(phase *PhaseData) time.Duration {
|
||||
// Retrieve all index, ilm-explain and ilm-policies in parallel
|
||||
func getIlmPhaseData(conf *cfg.Config) ([]PhaseData, error) {
|
||||
responses := make(chan apiResponse, 3)
|
||||
wg := new(sync.WaitGroup{})
|
||||
wg := &sync.WaitGroup{}
|
||||
wg.Add(3)
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, conf.DefaultCluster.ES(), responses, "indicesbytes")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, conf.DefaultCluster.ES(), responses, "explain")
|
||||
})
|
||||
|
||||
wg.Go(func() {
|
||||
getApiData(conf, conf.DefaultCluster.ES(), responses, "policies")
|
||||
})
|
||||
go getApiData(conf, conf.DefaultCluster.ES(), wg, responses, "indicesbytes")
|
||||
go getApiData(conf, conf.DefaultCluster.ES(), wg, responses, "explain")
|
||||
go getApiData(conf, conf.DefaultCluster.ES(), wg, responses, "policies")
|
||||
|
||||
wg.Wait()
|
||||
|
||||
@@ -338,7 +331,7 @@ func findNextPhase(policy types.IlmPolicy, currentPhase string) *NextPhase {
|
||||
// phase list to determine which comes next
|
||||
phases, start := registerPhases(policy, currentPhase)
|
||||
|
||||
nextPhase := new(NextPhase{})
|
||||
nextPhase := &NextPhase{}
|
||||
|
||||
// finally determine which phase comes next
|
||||
// exception: hot, where we look for rollover rules
|
||||
|
||||
@@ -37,11 +37,11 @@ func NodeList(conf *cfg.Config) error {
|
||||
|
||||
slog.Debug("ES result", "nodes", nodes)
|
||||
|
||||
table := printer.NewTableEmpty(conf).WithHeaders(
|
||||
"name", "ip", "load1m", "load5m", "load15m", "ram %", "heap %")
|
||||
table := printer.NewTable(conf, 7, len(nodes))
|
||||
table.Addheaders("name", "ip", "load1m", "load5m", "load15m", "ram %", "heap %")
|
||||
|
||||
for _, node := range nodes {
|
||||
table.AddRow(
|
||||
for idx, node := range nodes {
|
||||
table.Entries[idx] = []any{
|
||||
*node.Name,
|
||||
*node.Ip,
|
||||
*node.Load1M,
|
||||
@@ -49,7 +49,7 @@ func NodeList(conf *cfg.Config) error {
|
||||
*node.Load15M,
|
||||
node.RamPercent,
|
||||
node.HeapPercent,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
table.Sort()
|
||||
@@ -235,72 +235,3 @@ func NodeClients(conf *cfg.Config, nodename string) error {
|
||||
|
||||
return table.Print()
|
||||
}
|
||||
|
||||
func NodeUsage(conf *cfg.Config, nodeid string) error {
|
||||
usage := conf.DefaultCluster.ES().Nodes.Usage()
|
||||
|
||||
if nodeid != "" {
|
||||
usage.NodeId(nodeid)
|
||||
}
|
||||
|
||||
stats, err := usage.Do(context.Background())
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get node usage: %w", esErrorString(err))
|
||||
}
|
||||
|
||||
slog.Debug("ES result", "usage", stats)
|
||||
|
||||
table := printer.NewTableEmpty(conf).WithHeaders(
|
||||
"node",
|
||||
"bulk",
|
||||
"doc get",
|
||||
"doc mget",
|
||||
"doc update",
|
||||
"index doc",
|
||||
"index stats",
|
||||
"search",
|
||||
"msearch",
|
||||
"open pit",
|
||||
)
|
||||
|
||||
for id, actions := range stats.Nodes {
|
||||
node, err := getNodeName(conf, id)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
stat := actions.RestActions
|
||||
|
||||
table.AddRow(
|
||||
node,
|
||||
stat["bulk_action"],
|
||||
stat["document_get_action"],
|
||||
stat["document_mget_action"],
|
||||
stat["document_update_action"],
|
||||
stat["document_index_action"],
|
||||
stat["indices_stats_action"],
|
||||
stat["search_action"],
|
||||
stat["msearch_action"],
|
||||
stat["open_point_in_time"],
|
||||
)
|
||||
}
|
||||
|
||||
return table.Print()
|
||||
}
|
||||
|
||||
func getNodeName(conf *cfg.Config, id string) (string, error) {
|
||||
res, err := conf.DefaultCluster.ES().Nodes.Info().
|
||||
Metric("os").
|
||||
Do(context.Background())
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get node info: %w", esErrorString(err))
|
||||
}
|
||||
|
||||
for nodeid, node := range res.Nodes {
|
||||
if id == nodeid {
|
||||
return node.Name, nil
|
||||
}
|
||||
}
|
||||
|
||||
return "", nil
|
||||
}
|
||||
|
||||
@@ -19,6 +19,7 @@ package es
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
|
||||
"codeberg.org/scip/esctl/pkg/cfg"
|
||||
"github.com/elastic/go-elasticsearch/v9"
|
||||
@@ -60,7 +61,14 @@ type apiResponse struct {
|
||||
which int
|
||||
}
|
||||
|
||||
func getApiData(conf *cfg.Config, es *elasticsearch.TypedClient, reschan chan apiResponse, which string) {
|
||||
func getApiData(
|
||||
conf *cfg.Config,
|
||||
es *elasticsearch.TypedClient,
|
||||
wg *sync.WaitGroup,
|
||||
reschan chan apiResponse,
|
||||
which string) {
|
||||
defer wg.Done()
|
||||
|
||||
apiRes := apiResponse{}
|
||||
|
||||
var arerr error
|
||||
|
||||
@@ -20,8 +20,6 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"slices"
|
||||
|
||||
"codeberg.org/scip/esctl/pkg/cfg"
|
||||
"codeberg.org/scip/esctl/pkg/printer"
|
||||
@@ -35,7 +33,15 @@ func RoleNames(conf *cfg.Config) ([]string, error) {
|
||||
return nil, fmt.Errorf("failed to get roles: %w", esErrorString(err))
|
||||
}
|
||||
|
||||
return slices.Collect(maps.Keys(res)), nil
|
||||
roles := make([]string, len(res))
|
||||
|
||||
idx := 0
|
||||
for name := range res {
|
||||
roles[idx] = name
|
||||
idx++
|
||||
}
|
||||
|
||||
return roles, nil
|
||||
}
|
||||
|
||||
func RoleList(conf *cfg.Config) error {
|
||||
|
||||
@@ -127,7 +127,7 @@ func getCsvRecord(conf *cfg.Config, csvfile, rolename string) (*Record, error) {
|
||||
}()
|
||||
|
||||
scanner := bufio.NewScanner(fd)
|
||||
record := new(Record{role: rolename})
|
||||
record := Record{role: rolename}
|
||||
|
||||
for scanner.Scan() {
|
||||
line := strings.TrimSpace(scanner.Text())
|
||||
@@ -150,7 +150,7 @@ func getCsvRecord(conf *cfg.Config, csvfile, rolename string) (*Record, error) {
|
||||
}
|
||||
}
|
||||
|
||||
return record, nil
|
||||
return &record, nil
|
||||
}
|
||||
|
||||
func diffRoles(conf *cfg.Config, records map[string]Record, res getrole.Response) []Register {
|
||||
|
||||
@@ -56,7 +56,7 @@ func Search(conf *cfg.Config, queries []string) error {
|
||||
return err
|
||||
}
|
||||
|
||||
req := new(search.Request{Query: queryCaster})
|
||||
req := &search.Request{Query: queryCaster}
|
||||
|
||||
searchEs.Request(req)
|
||||
|
||||
@@ -128,7 +128,7 @@ func validateSearch(conf *cfg.Config, queries []string) error {
|
||||
return err
|
||||
}
|
||||
|
||||
req := new(validatequery.Request{Query: queryCaster})
|
||||
req := &validatequery.Request{Query: queryCaster}
|
||||
|
||||
validate.Request(req)
|
||||
|
||||
|
||||
@@ -80,7 +80,7 @@ func NewFilter(query string) (*filter, error) {
|
||||
return nil, errors.New("search queries must be in the form field<sep>pattern where <sep> must be one of: = or !=")
|
||||
}
|
||||
|
||||
flt := new(filter{term: part[0], filter: part[1], criteria: criteria})
|
||||
flt := &filter{term: part[0], filter: part[1], criteria: criteria}
|
||||
|
||||
if strings.Contains(part[0], ",") {
|
||||
// a MultiMatchQuery, match across multiple fields at once
|
||||
|
||||
@@ -1,79 +0,0 @@
|
||||
/*
|
||||
Copyright © 2026 Thomas von Dein
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
package es
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
|
||||
"codeberg.org/scip/esctl/pkg/cfg"
|
||||
"codeberg.org/scip/esctl/pkg/printer"
|
||||
)
|
||||
|
||||
type searchQlColumn struct {
|
||||
Name string `json:"name"`
|
||||
Type string `json:"type"`
|
||||
}
|
||||
|
||||
type searchQlResult struct {
|
||||
Partial bool `json:"is_partial"`
|
||||
Docs int `json:"documents_found"`
|
||||
Columns []searchQlColumn `json:"columns"`
|
||||
Values [][]any `json:"values"`
|
||||
}
|
||||
|
||||
func SearchQL(conf *cfg.Config, querystring string) error {
|
||||
query := conf.DefaultCluster.ES().Esql.Query().
|
||||
Query(querystring).
|
||||
DropNullColumns(true)
|
||||
|
||||
res, err := query.Do(context.Background())
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to run esql query: %w", esErrorString(err))
|
||||
}
|
||||
|
||||
if conf.Debug {
|
||||
fmt.Println(string(res))
|
||||
}
|
||||
|
||||
qlResult := searchQlResult{}
|
||||
|
||||
if err = json.Unmarshal(res, &qlResult); err != nil {
|
||||
return fmt.Errorf("failed to unmarshal esql result: %w", err)
|
||||
}
|
||||
|
||||
slog.Debug("searchql result", "qlres", qlResult)
|
||||
|
||||
if qlResult.Docs == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
table := printer.NewTable(conf, len(qlResult.Columns), len(qlResult.Values))
|
||||
|
||||
headers := make([]string, len(qlResult.Columns))
|
||||
for idx, col := range qlResult.Columns {
|
||||
headers[idx] = col.Name
|
||||
}
|
||||
|
||||
table.Addheaders(headers...)
|
||||
|
||||
table.Entries = qlResult.Values
|
||||
|
||||
return table.Print()
|
||||
}
|
||||
@@ -66,13 +66,13 @@ func SnapshotList(conf *cfg.Config) error {
|
||||
snapshots := []*Snapshot{} // original snapshot names
|
||||
|
||||
for _, snapshot := range sres {
|
||||
snap := new(Snapshot{
|
||||
snap := &Snapshot{
|
||||
Name: *snapshot.Id,
|
||||
Status: *snapshot.Status,
|
||||
Start: fmt.Sprintf("%s", snapshot.StartTime),
|
||||
Forindex: indexFromSnapshot(*snapshot.Id),
|
||||
Orphaned: "no",
|
||||
})
|
||||
}
|
||||
|
||||
_, exists := indicies[snap.Forindex]
|
||||
if !exists {
|
||||
|
||||
@@ -29,13 +29,13 @@ import (
|
||||
const LevelNotice = slog.Level(2)
|
||||
|
||||
func Init(conf *cfg.Config) {
|
||||
logLevel := new(slog.LevelVar{})
|
||||
logLevel := &slog.LevelVar{}
|
||||
|
||||
opts := new(yadu.Options{
|
||||
opts := &yadu.Options{
|
||||
Level: logLevel,
|
||||
AddSource: true,
|
||||
NoColor: !isatty.IsTerminal(os.Stdout.Fd()),
|
||||
})
|
||||
}
|
||||
|
||||
buildInfo, _ := debug.ReadBuildInfo()
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ func (b *ByteSize) String() string {
|
||||
}
|
||||
|
||||
func Bytes(size int64) *ByteSize {
|
||||
return new(ByteSize{size: uint64(size)})
|
||||
return &ByteSize{size: uint64(size)}
|
||||
}
|
||||
|
||||
func ByteString(size int64) string {
|
||||
|
||||
@@ -30,44 +30,33 @@ import (
|
||||
)
|
||||
|
||||
type Table struct {
|
||||
Mode string // tsv, json, yaml
|
||||
Headers []string
|
||||
RawHeaders []string
|
||||
Entries [][]any
|
||||
Mode string // tsv, json, yaml
|
||||
Headers []string
|
||||
Entries [][]any
|
||||
|
||||
rows [][]string // representation used for printing
|
||||
processed bool
|
||||
lenHeaders []int
|
||||
alignInts bool
|
||||
maxwidth int
|
||||
debugGoRoutines bool
|
||||
rows [][]string // representation used for printing
|
||||
processed bool
|
||||
lenHeaders []int
|
||||
alignInts bool
|
||||
maxwidth int
|
||||
}
|
||||
|
||||
func NewTable(conf *cfg.Config, columns, rows int) *Table {
|
||||
table := new(Table{
|
||||
Mode: conf.Output,
|
||||
maxwidth: cfg.GetTermWidth(),
|
||||
debugGoRoutines: conf.DebugGoRoutines,
|
||||
})
|
||||
table := Table{Mode: conf.Output, maxwidth: cfg.GetTermWidth()}
|
||||
|
||||
table.Headers = make([]string, columns)
|
||||
table.RawHeaders = make([]string, columns)
|
||||
table.Entries = make([][]any, rows)
|
||||
table.lenHeaders = make([]int, columns)
|
||||
table.alignInts = conf.AlignInts
|
||||
|
||||
return table
|
||||
return &table
|
||||
}
|
||||
|
||||
func NewTableEmpty(conf *cfg.Config) *Table {
|
||||
table := new(Table{
|
||||
Mode: conf.Output,
|
||||
maxwidth: cfg.GetTermWidth(),
|
||||
debugGoRoutines: conf.DebugGoRoutines,
|
||||
})
|
||||
table := Table{Mode: conf.Output, maxwidth: cfg.GetTermWidth()}
|
||||
table.alignInts = conf.AlignInts
|
||||
|
||||
return table
|
||||
return &table
|
||||
}
|
||||
|
||||
func (table *Table) WithHeaders(headers ...string) *Table {
|
||||
@@ -76,7 +65,6 @@ func (table *Table) WithHeaders(headers ...string) *Table {
|
||||
table.Entries = [][]any{}
|
||||
table.lenHeaders = make([]int, count)
|
||||
table.Headers = make([]string, count)
|
||||
table.RawHeaders = make([]string, count)
|
||||
|
||||
table.Addheaders(headers...)
|
||||
|
||||
@@ -84,24 +72,14 @@ func (table *Table) WithHeaders(headers ...string) *Table {
|
||||
}
|
||||
|
||||
func (table *Table) Print() error {
|
||||
var err error
|
||||
|
||||
switch table.Mode {
|
||||
case "json":
|
||||
err = table.PrintJSON()
|
||||
return table.PrintJSON()
|
||||
case "yaml":
|
||||
err = table.PrintYAML()
|
||||
case "csv":
|
||||
err = table.PrintCSV()
|
||||
return table.PrintYAML()
|
||||
default:
|
||||
err = table.PrintTSV()
|
||||
return table.PrintTSV()
|
||||
}
|
||||
|
||||
if table.debugGoRoutines {
|
||||
printGoRoutineMetrics()
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
var (
|
||||
@@ -166,11 +144,9 @@ func (table *Table) PrintTSV() error {
|
||||
wrapped := wrapper(entry)
|
||||
|
||||
// and indent it
|
||||
first := true
|
||||
for line := range strings.Lines(wrapped) {
|
||||
if first {
|
||||
for idx, line := range strings.Split(wrapped, "\n") {
|
||||
if idx == 0 {
|
||||
entry = line
|
||||
first = false
|
||||
} else {
|
||||
entry += "\n " + strings.Repeat(" ", currentWidth) + line
|
||||
}
|
||||
@@ -202,28 +178,6 @@ func (table *Table) PrintTSV() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (table *Table) PrintCSV() error {
|
||||
table.preprocessRows()
|
||||
|
||||
fmt.Println(strings.Join(table.RawHeaders, ","))
|
||||
|
||||
for _, entries := range table.rows {
|
||||
row := make([]string, len(entries))
|
||||
|
||||
for idx, entry := range entries {
|
||||
if strings.Contains(entry, " ") || strings.Contains(entry, ",") {
|
||||
row[idx] = `"` + entry + `"`
|
||||
} else {
|
||||
row[idx] = entry
|
||||
}
|
||||
}
|
||||
|
||||
fmt.Println(strings.Join(row, ","))
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (table *Table) Sort() {
|
||||
// sanity checks
|
||||
if len(table.Entries) == 0 {
|
||||
@@ -245,8 +199,6 @@ func (table *Table) Addheaders(headers ...string) {
|
||||
default:
|
||||
table.Headers[idx] = bold(strings.ReplaceAll(strings.ToUpper(header), " ", "-"))
|
||||
}
|
||||
|
||||
table.RawHeaders[idx] = header
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user