prunr 0.1.0__tar.gz

prunr-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026-present Rui Ma
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

prunr-0.1.0/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: prunr
+Version: 0.1.0
+Summary: Scan your Elasticsearch/OpenSearch cluster. Find dead indices, wasted storage, and cost savings.
+Author-email: Ricky Ma <ricky.rui.ma@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rickyruima/prunr
+Project-URL: Issues, https://github.com/rickyruima/prunr/issues
+Keywords: elasticsearch,opensearch,cost,optimization,observability
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: opensearch-py>=2.4
+Requires-Dist: elasticsearch>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# Prunr
+
+**Scan your Elasticsearch / OpenSearch cluster. Find dead indices, wasted storage, and cost savings.**
+
+Prunr is a read-only CLI tool that connects to your cluster, analyzes index usage patterns, and tells you exactly what you can safely delete, shrink, or archive — with confidence levels and estimated savings.
+
+> **Prunr never writes to your cluster.** All operations are read-only. It uses `_cat/indices`, `_stats`, and `_cluster/health` — nothing else.
+
+---
+
+## Install
+
+```bash
+pip install prunr
+```
+
+Or with [pipx](https://pipx.pypa.io/) (recommended):
+
+```bash
+pipx install prunr
+```
+
+Requires Python 3.11+.
+
+## Quick start
+
+```bash
+# Scan a cluster
+prunr scan --host http://localhost:9200
+
+# With authentication
+prunr scan --host https://my-cluster:9200 --user admin --password secret
+
+# Save JSON report
+prunr scan --host http://localhost:9200 --format json --output report.json
+
+# Try it without a cluster (built-in demo data)
+prunr scan --demo
+```
+
+## Sample output
+
+```
+╭──────────────────────────────────────────────────────────────────────────────╮
+│ PRUNR CLUSTER REPORT                                                         │
+│ Cluster: prod-logging-cluster  |  26 indices  |  1024.3 GB  |  12 nodes      │
+│ Scanned: 2026-04-13 01:24:38 UTC                                             │
+╰──────────────────────────────────────────────────────────────────────────────╯
+
+╭─────────────────────────────── Cost Overview ────────────────────────────────╮
+│   ESTIMATED MONTHLY COST:  $102                                              │
+│   ESTIMATED ANNUAL WASTE:  $167                                              │
+╰──────────────────────────────────────────────────────────────────────────────╯
+
+TOP RECOMMENDATIONS (by annual savings)
+
+  1. REVIEW  api-access-* (multiple patterns)  (90.3 GB)
+     Confidence: LOW
+     Annual savings: $54
+     Reasoning:
+       ⚠ Service 'api-access' appears in 2 different index patterns
+       ⚠ These may contain overlapping data from multiple pipelines
+
+  2. DELETE  filebeat-2024.01  (26.1 GB)
+     Confidence: MEDIUM
+     Annual savings: $31
+     Reasoning:
+       ⚠ 0 queries since cluster restart
+       ⚠ 0 indexing activity
+
+  3. DELETE  debug-traces-2024.08.15  (11.5 GB)
+     Confidence: HIGH
+     Annual savings: $14
+     Reasoning:
+       ✓ 0 queries since cluster restart
+       ✓ 0 indexing activity
+       ✓ Index name matches low-value pattern: debug-traces-2024.08.15
+```
+
+A full sample JSON report is in [`examples/sample-report.json`](examples/sample-report.json).
+
+## What Prunr detects
+
+| Analyzer | What it finds | Action |
+|---|---|---|
+| **Dead index** | Indices with 0 queries and 0 writes since last restart | DELETE |
+| **Retention** | Date-based index series where old indices are never queried | REDUCE RETENTION |
+| **Storage hog** | Largest indices by size — surfaces the biggest saving opportunities | REVIEW |
+| **Duplicate** | Multiple versioned indices (e.g. `logs-v1`, `logs-v2`) that may overlap | REVIEW |
+| **Shard** | Over-sharded indices (many tiny shards wasting cluster memory) | MERGE SHARDS |
+
+Each recommendation includes:
+- **Confidence level**: HIGH, MEDIUM, or LOW
+- **Evidence**: specific metrics (query count, indexing rate, size, pattern matches)
+- **Estimated annual savings** in USD (based on `--cost-per-gb`, default $0.10/GB/mo)
+
+## Confidence levels
+
+| Level | Meaning |
+|---|---|
+| **HIGH** | Strong evidence — safe to act on after quick verification |
+| **MEDIUM** | Likely waste — worth investigating |
+| **LOW** | Possible issue — needs human review before acting |
+
+## CLI reference
+
+```
+prunr scan [OPTIONS]
+
+Options:
+  --host TEXT              ES/OpenSearch URL (e.g. https://localhost:9200)
+  --api-key TEXT           API key for authentication
+  --user TEXT              Username for basic auth
+  --password TEXT          Password for basic auth
+  --cost-per-gb FLOAT     Cost per GB per month in USD (default: 0.10)
+  --format [terminal|json] Output format (default: terminal)
+  --output TEXT            Save report to file
+  --no-verify-certs       Skip TLS certificate verification
+  --demo                  Run with built-in sample data (no cluster needed)
+```
+
+## Safety
+
+Prunr is **strictly read-only**. It will never:
+
+- Delete, close, or modify any index
+- Change cluster settings
+- Write data to your cluster
+- Require any write permissions
+
+The only APIs it calls are:
+- `GET /` (version check)
+- `GET /_cat/indices`
+- `GET /_stats`
+- `GET /_cluster/health`
+
+You can safely run it against production clusters.
+
+## Limitations
+
+- Query and indexing counts reset on node restart — Prunr can only see activity since the last restart
+- Cost estimates use a flat $/GB/month rate; real costs depend on instance types, reserved pricing, and I/O
+- Duplicate detection is heuristic (name-pattern based), not content-based
+- Currently supports a single cluster per scan
+
+## Development
+
+```bash
+git clone https://github.com/rickyruima/prunr.git
+cd prunr
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest -v
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE) for details.

prunr-0.1.0/README.md

@@ -0,0 +1,158 @@
+# Prunr
+
+**Scan your Elasticsearch / OpenSearch cluster. Find dead indices, wasted storage, and cost savings.**
+
+Prunr is a read-only CLI tool that connects to your cluster, analyzes index usage patterns, and tells you exactly what you can safely delete, shrink, or archive — with confidence levels and estimated savings.
+
+> **Prunr never writes to your cluster.** All operations are read-only. It uses `_cat/indices`, `_stats`, and `_cluster/health` — nothing else.
+
+---
+
+## Install
+
+```bash
+pip install prunr
+```
+
+Or with [pipx](https://pipx.pypa.io/) (recommended):
+
+```bash
+pipx install prunr
+```
+
+Requires Python 3.11+.
+
+## Quick start
+
+```bash
+# Scan a cluster
+prunr scan --host http://localhost:9200
+
+# With authentication
+prunr scan --host https://my-cluster:9200 --user admin --password secret
+
+# Save JSON report
+prunr scan --host http://localhost:9200 --format json --output report.json
+
+# Try it without a cluster (built-in demo data)
+prunr scan --demo
+```
+
+## Sample output
+
+```
+╭──────────────────────────────────────────────────────────────────────────────╮
+│ PRUNR CLUSTER REPORT                                                         │
+│ Cluster: prod-logging-cluster  |  26 indices  |  1024.3 GB  |  12 nodes      │
+│ Scanned: 2026-04-13 01:24:38 UTC                                             │
+╰──────────────────────────────────────────────────────────────────────────────╯
+
+╭─────────────────────────────── Cost Overview ────────────────────────────────╮
+│   ESTIMATED MONTHLY COST:  $102                                              │
+│   ESTIMATED ANNUAL WASTE:  $167                                              │
+╰──────────────────────────────────────────────────────────────────────────────╯
+
+TOP RECOMMENDATIONS (by annual savings)
+
+  1. REVIEW  api-access-* (multiple patterns)  (90.3 GB)
+     Confidence: LOW
+     Annual savings: $54
+     Reasoning:
+       ⚠ Service 'api-access' appears in 2 different index patterns
+       ⚠ These may contain overlapping data from multiple pipelines
+
+  2. DELETE  filebeat-2024.01  (26.1 GB)
+     Confidence: MEDIUM
+     Annual savings: $31
+     Reasoning:
+       ⚠ 0 queries since cluster restart
+       ⚠ 0 indexing activity
+
+  3. DELETE  debug-traces-2024.08.15  (11.5 GB)
+     Confidence: HIGH
+     Annual savings: $14
+     Reasoning:
+       ✓ 0 queries since cluster restart
+       ✓ 0 indexing activity
+       ✓ Index name matches low-value pattern: debug-traces-2024.08.15
+```
+
+A full sample JSON report is in [`examples/sample-report.json`](examples/sample-report.json).
+
+## What Prunr detects
+
+| Analyzer | What it finds | Action |
+|---|---|---|
+| **Dead index** | Indices with 0 queries and 0 writes since last restart | DELETE |
+| **Retention** | Date-based index series where old indices are never queried | REDUCE RETENTION |
+| **Storage hog** | Largest indices by size — surfaces the biggest saving opportunities | REVIEW |
+| **Duplicate** | Multiple versioned indices (e.g. `logs-v1`, `logs-v2`) that may overlap | REVIEW |
+| **Shard** | Over-sharded indices (many tiny shards wasting cluster memory) | MERGE SHARDS |
+
+Each recommendation includes:
+- **Confidence level**: HIGH, MEDIUM, or LOW
+- **Evidence**: specific metrics (query count, indexing rate, size, pattern matches)
+- **Estimated annual savings** in USD (based on `--cost-per-gb`, default $0.10/GB/mo)
+
+## Confidence levels
+
+| Level | Meaning |
+|---|---|
+| **HIGH** | Strong evidence — safe to act on after quick verification |
+| **MEDIUM** | Likely waste — worth investigating |
+| **LOW** | Possible issue — needs human review before acting |
+
+## CLI reference
+
+```
+prunr scan [OPTIONS]
+
+Options:
+  --host TEXT              ES/OpenSearch URL (e.g. https://localhost:9200)
+  --api-key TEXT           API key for authentication
+  --user TEXT              Username for basic auth
+  --password TEXT          Password for basic auth
+  --cost-per-gb FLOAT     Cost per GB per month in USD (default: 0.10)
+  --format [terminal|json] Output format (default: terminal)
+  --output TEXT            Save report to file
+  --no-verify-certs       Skip TLS certificate verification
+  --demo                  Run with built-in sample data (no cluster needed)
+```
+
+## Safety
+
+Prunr is **strictly read-only**. It will never:
+
+- Delete, close, or modify any index
+- Change cluster settings
+- Write data to your cluster
+- Require any write permissions
+
+The only APIs it calls are:
+- `GET /` (version check)
+- `GET /_cat/indices`
+- `GET /_stats`
+- `GET /_cluster/health`
+
+You can safely run it against production clusters.
+
+## Limitations
+
+- Query and indexing counts reset on node restart — Prunr can only see activity since the last restart
+- Cost estimates use a flat $/GB/month rate; real costs depend on instance types, reserved pricing, and I/O
+- Duplicate detection is heuristic (name-pattern based), not content-based
+- Currently supports a single cluster per scan
+
+## Development
+
+```bash
+git clone https://github.com/rickyruima/prunr.git
+cd prunr
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+pytest -v
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE) for details.

prunr-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "prunr"
+version = "0.1.0"
+description = "Scan your Elasticsearch/OpenSearch cluster. Find dead indices, wasted storage, and cost savings."
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.11"
+authors = [{ name = "Ricky Ma", email = "ricky.rui.ma@gmail.com" }]
+keywords = ["elasticsearch", "opensearch", "cost", "optimization", "observability"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "Topic :: System :: Monitoring",
+]
+dependencies = [
+    "click>=8.0",
+    "rich>=13.0",
+    "opensearch-py>=2.4",
+    "elasticsearch>=8.0",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "ruff>=0.4"]
+
+[project.scripts]
+prunr = "prunr.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/rickyruima/prunr"
+Issues = "https://github.com/rickyruima/prunr/issues"
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

prunr-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

prunr-0.1.0/src/prunr/__init__.py

@@ -0,0 +1,3 @@
+"""Prunr — Find dead indices, wasted storage, and cost savings in your ES/OpenSearch cluster."""
+
+__version__ = "0.1.0"