{"id":51861576,"url":"https://github.com/wlanboy/opensearch-analyze","last_synced_at":"2026-07-24T08:01:37.187Z","repository":{"id":372155144,"uuid":"1305499898","full_name":"wlanboy/opensearch-analyze","owner":"wlanboy","description":"Python based opensearch analyze tool","archived":false,"fork":false,"pushed_at":"2026-07-19T07:31:25.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-19T09:13:35.291Z","etag":null,"topics":["analyse","mirror","opensearch","python","statistics"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wlanboy.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-07-19T07:10:02.000Z","updated_at":"2026-07-19T07:31:38.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/wlanboy/opensearch-analyze","commit_stats":null,"previous_names":["wlanboy/opensearch-analyze"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/wlanboy/opensearch-analyze","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wlanboy%2Fopensearch-analyze","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wlanboy%2Fopensearch-analyze/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wlanboy%2Fopensearch-analyze/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wlanboy%2Fopensearch-analyze/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wlanboy","download_url":"https://codeload.github.com/wlanboy/opensearch-analyze/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wlanboy%2Fopensearch-analyze/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35832970,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-24T02:00:07.870Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analyse","mirror","opensearch","python","statistics"],"created_at":"2026-07-24T08:01:36.501Z","updated_at":"2026-07-24T08:01:37.175Z","avatar_url":"https://github.com/wlanboy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# opensearch-analyze\n\nLokales Setup zum Betrieb und zur Analyse eines [OpenSearch](https://opensearch.org/)-Clusters:\nein Docker-Compose-Stack mit einem 2-Node-Cluster, Log-Shipping über\n[Fluent Bit](https://fluentbit.io/) sowie ein Python-CLI-Tool, das Cluster-, Index- und\nNode-Metriken auswertet und als Text- oder JSON-Report ausgibt.\n\n## Bestandteile\n\n| Komponente | Beschreibung |\n|---|---|\n| [docker-compose.yml](docker-compose.yml) | Startet den OpenSearch-Cluster (mit aktivem Security-Plugin), Fluent Bit und OpenSearch Dashboards |\n| [opensearch-analyze.py](opensearch-analyze.py) | CLI-Report über Cluster-Health, Index-Stats und Node-Health |\n| [conf/fluent-bit.conf](conf/fluent-bit.conf) | Fluent-Bit-Konfiguration (Syslog/Kernel-Log → OpenSearch) |\n| [adduser.sh](adduser.sh) | Legt den read-only OpenSearch-User für opensearch-analyze.py an und schreibt ihn nach `.env` |\n| [stress.sh](stress.sh) | Erzeugt Testdaten und teure Queries für lange-Queries-Analyse |\n\n## Architektur\n\n```\nopensearch-1 ─┐\n              ├─ Cluster \"opensearch-cluster\"\nopensearch-2 ─┘\n      │\n      ├── fluent-bit ────────── liest /var/log/syslog, /var/log/kern.log\n      └── opensearch-dashboards ── UI auf Port 5601\n```\n\n## Setup\n\n```bash\ncp .env-example .env\n# OPENSEARCH_INITIAL_ADMIN_PASSWORD in .env auf ein starkes Passwort setzen\n# (min. 8 Zeichen, Groß-/Kleinbuchstabe, Ziffer, Sonderzeichen)\n\ndocker compose up -d\n./adduser.sh   # legt den read-only Analyzer-User an und schreibt ihn nach .env\n```\n\n`adduser.sh` legt eine minimal berechtigte Rolle (`cluster_monitor` +\n`indices_monitor`) und einen zugehörigen User (`opensearch-analyzer`) über die\nSecurity-REST-API an, generiert dafür ein zufälliges Passwort und schreibt\n`OPENSEARCH_HOST`/`OPENSEARCH_USER`/`OPENSEARCH_PASSWORD`/`OPENSEARCH_INSECURE`\nnach `.env`. Erneutes Ausführen rotiert das Passwort.\n\n| Service | URL |\n|---|---|\n| OpenSearch Node 1 | https://localhost:9200 |\n| OpenSearch Node 2 | https://localhost:9201 |\n| OpenSearch Dashboards | http://localhost:5601 |\n| Cluster-Health | https://localhost:9200/_cluster/health |\n\nDas Cluster nutzt selbstsignierte Demo-Zertifikate (`OPENSEARCH_INSECURE=true`\nin `.env`) — für produktive Cluster stattdessen `--ca-cert` mit einer echten CA\nverwenden.\n\n## opensearch-analyze.py\n\nAnalysiert Cluster-Health, Index-Stats (Search/Indexing/Store/Docs/Merge/Caches) und\nNode-Health (Heap, Disk-Watermarks, Cache-Hit-Ratio, langsame Queries) über die OpenSearch-REST-API.\nLiest Host/User/Passwort automatisch aus `.env`, sofern vorhanden — für den lokalen\nDocker-Compose-Stack reicht nach `./adduser.sh` ein einfaches `./opensearch-analyze.py`.\n\n```bash\n./opensearch-analyze.py\n./opensearch-analyze.py --json\n./opensearch-analyze.py --watch --interval 15\n./opensearch-analyze.py --long-queries-type cpu --long-queries-limit 5\n```\n\n| Option | Beschreibung |\n|---|---|\n| `--host` | OpenSearch-Basis-URL (Default: `.env`/`$OPENSEARCH_HOST` oder `http://localhost:9200`) |\n| `--json` | Ausgabe als JSON statt Textreport |\n| `--watch` | Wiederholte Ausführung im Intervall |\n| `--interval` | Sekunden zwischen zwei Läufen im `--watch`-Modus (Default: 10) |\n| `--long-queries-type` | Sortierkriterium für langsame Queries: `latency`, `cpu`, `memory` |\n| `--long-queries-limit` | Anzahl der angezeigten langsamen Queries |\n| `--user`, `-u` | Basic-Auth-Benutzername, falls das Security-Plugin aktiv ist (Default: `.env`/`$OPENSEARCH_USER`) |\n| `--password` | Basic-Auth-Passwort (Default: `.env`/`$OPENSEARCH_PASSWORD`); bei `--user` ohne Passwort wird interaktiv nachgefragt |\n| `--ca-cert` | Pfad zu einem CA-Bundle für ein selbstsigniertes TLS-Zertifikat (Default: `.env`/`$OPENSEARCH_CA_CERT`) |\n| `--insecure`, `-k` | TLS-Zertifikatsprüfung überspringen (Default: `.env`/`$OPENSEARCH_INSECURE`); nur für lokale/Dev-Setups |\n\n## adduser.sh\n\n```bash\n./adduser.sh                                  # gegen den lokalen Compose-Stack, Passwort aus .env\n./adduser.sh --host https://prod:9200 --admin-password '...'   # gegen einen anderen Cluster\n./adduser.sh --user my-monitor --role my-monitor-role\n```\n\n| Option | Beschreibung |\n|---|---|\n| `--host` | OpenSearch-Basis-URL (Default: `.env`/`$OPENSEARCH_HOST` oder `https://localhost:9200`) |\n| `--admin-user` | Admin-Benutzer für die Security-API (Default: `admin`) |\n| `--admin-password` | Admin-Passwort (Default: `.env`/`$OPENSEARCH_INITIAL_ADMIN_PASSWORD`, sonst Prompt) |\n| `--user` | Anzulegender Analyzer-User (Default: `opensearch-analyzer`) |\n| `--password` | Festes Passwort statt eines generierten (nicht empfohlen) |\n| `--role` | Name der anzulegenden Rolle (Default: `opensearch-analyzer-monitor`) |\n| `--insecure` / `--no-insecure` | TLS-Zertifikatsprüfung überspringen/erzwingen (Default: `.env`/`$OPENSEARCH_INSECURE`) |\n\n## stress.sh\n\nAktiviert das [Query-Insights-Plugin](https://opensearch.org/docs/latest/observing-your-data/query-insights/index/)\n(`/_insights/top_queries`), seedet einen Testindex und feuert parallel absichtlich\nteure Queries (Wildcard, Regexp, Script-Score, High-Cardinality-Aggregationen,\nDeep Pagination, Fuzzy-Match), damit `opensearch-analyze.py --long-queries-*`\nreale Daten anzeigt. Legt Indizes an und schreibt Dokumente, braucht daher\nAdmin-/Write-Zugangsdaten (Default: `admin` mit `$OPENSEARCH_INITIAL_ADMIN_PASSWORD`\naus `.env`) — nicht den read-only User von `adduser.sh`.\n\n```bash\n./stress.sh                                   # Standardlauf (20000 Docs, 20 Runden)\n./stress.sh --docs 2000 --rounds 5            # kleinerer/schnellerer Lauf\n./stress.sh --skip-seed --rounds 10           # Index bereits vorhanden, nur Queries feuern\n./stress.sh --cleanup                         # Testindex wieder löschen\n```\n\n| Option | Beschreibung |\n|---|---|\n| `--host` | OpenSearch-Basis-URL (Default: `.env`/`$OPENSEARCH_HOST` oder `http://localhost:9200`) |\n| `--index` | Name des Testindex (Default: `stress-test-logs`) |\n| `--docs` | Anzahl generierter Dokumente (Default: 20000) |\n| `--rounds` | Query-Runden pro Query-Typ (Default: 20) |\n| `--parallel` | Parallele Requests je Runde (Default: 8) |\n| `--user` | Basic-Auth-Benutzer (Default: `admin`) |\n| `--password` | Basic-Auth-Passwort (Default: `.env`/`$OPENSEARCH_INITIAL_ADMIN_PASSWORD`) |\n| `--insecure` | TLS-Zertifikatsprüfung überspringen (Default: `.env`/`$OPENSEARCH_INSECURE`) |\n| `--skip-seed` | Indexierung überspringen, nur Queries feuern |\n| `--cleanup` | Testindex löschen und beenden |\n\n`delete.sh` löscht denselben Testindex eigenständig und akzeptiert dieselben\n`--host`/`--user`/`--password`/`--insecure`-Optionen.\n\nErgebnisse danach mit:\n```bash\n./opensearch-analyze.py --long-queries-type latency --long-queries-limit 10\n./opensearch-analyze.py --long-queries-type cpu --long-queries-limit 10\n```\n\n## Referenzen\n\n- [OpenSearch Documentation](https://opensearch.org/docs/latest/)\n- [OpenSearch Cluster Health API](https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/)\n- [OpenSearch Cluster Formation](https://opensearch.org/docs/latest/tuning-your-cluster/)\n- [OpenSearch Query Insights Plugin](https://opensearch.org/docs/latest/observing-your-data/query-insights/index/)\n- [OpenSearch Dashboards](https://opensearch.org/docs/latest/dashboards/index/)\n- [Fluent Bit Documentation](https://docs.fluentbit.io/manual)\n- [Fluent Bit OpenSearch Output Plugin](https://docs.fluentbit.io/manual/pipeline/outputs/opensearch)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwlanboy%2Fopensearch-analyze","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwlanboy%2Fopensearch-analyze","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwlanboy%2Fopensearch-analyze/lists"}