llmtrafficlens 0.1.0__tar.gz

llmtrafficlens-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+.ltl-salt
+dist/
+__pycache__/
+*.egg-info/

llmtrafficlens-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

llmtrafficlens-0.1.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: llmtrafficlens
+Version: 0.1.0
+Summary: LLM gateway traffic profiler: prefix-reuse analysis, cache-hit-rate upper bounds, and anonymized replayable trace export
+Project-URL: Homepage, https://github.com/Belyenochi/llmtrafficlens
+Author: Jason Zhu
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: benchmark,kv-cache,llm,mooncake,prefix-cache,trace,traffic-analysis,workload-characterization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Benchmark
+Requires-Python: >=3.10
+Provides-Extra: tokenizer
+Requires-Dist: tokenizers>=0.15; extra == 'tokenizer'
+Description-Content-Type: text/markdown
+
+# llmtrafficlens
+
+**LLM gateway traffic profiler** — analyze prefix-reuse structure in your
+gateway logs, estimate the prefix-cache hit-rate ceiling *before* you build
+KV-cache-aware routing, and export anonymized replayable traces in
+community-standard formats.
+
+Every KV-cache product tells you how much you saved *after* deployment.
+`llmtrafficlens` answers the prior question: **is your traffic worth it, and
+what is the upper bound?**
+
+## What it does
+
+1. **Traffic profile** — input/output token distributions, streaming ratio,
+   model mix, error rates.
+2. **Prefix structure** — distinct prefixes, shared-prefix groups, and a
+   **dual-metric leaderboard**: top prefixes *by reuse count* vs *by reusable
+   token volume*. The two heads routinely differ: a 15-token prefix reused
+   870× is worthless to a cache, a 19K-token prefix reused 95× dominates it.
+3. **Session-shape detection** — presence rate of session identifiers
+   (`prompt_cache_key`, `metadata.*`): tells you whether reuse is
+   *cross-request shared-prefix* shaped (needs prefix-aware routing) or
+   *intra-session* shaped (session affinity suffices).
+4. **Reuse potential** — ECHR (engine cache hit rate) upper bound under
+   infinite cache + perfect routing, plus an LRU capacity/hit-rate curve.
+5. **Anonymized export** — qwen-bailian-superset or Mooncake JSONL (salted
+   chained block hashes; no text leaves your machine), directly replayable
+   by NVIDIA AIPerf, SGLang bench_serving, and AIBrix.
+6. **Generator fitting** — emit SGLang `generated-shared-prefix` CLI args
+   (zipf popularity fitted to your histogram) with a fidelity report.
+
+## Install
+
+```bash
+pip install llmtrafficlens
+```
+
+Zero runtime dependencies. Python ≥ 3.10.
+
+## Quickstart on a public trace
+
+Validate the analyzer against the public [Mooncake
+trace](https://github.com/kvcache-ai/Mooncake) (FAST'25) — the result should
+match the official [KV Cache Hit Rate
+Simulator](https://kvcache.ai/tools/kv-cache-hit-rate-simulator/)'s
+infinite-capacity ceiling:
+
+```bash
+curl -LO https://raw.githubusercontent.com/kvcache-ai/Mooncake/main/FAST25-release/traces/conversation_trace.jsonl
+llmtrafficlens validate conversation_trace.jsonl --format mooncake
+llmtrafficlens profile  conversation_trace.jsonl --format mooncake -o mooncake-report
+```
+
+## Profile your own gateway logs
+
+Input: a CSV with a `request_json` column holding the OpenAI-format request
+body (optional `response_json`, `model_name`, `status_code` columns are
+picked up when present).
+
+```bash
+llmtrafficlens profile gateway.csv -o report
+# -> report.json + report.html
+```
+
+All processing is local. The report contains aggregates only — raw prompts
+never appear in any output.
+
+Token counts use a chars/4 approximation unless the log carries `usage`
+(then exact counts are used and marked in the report). A keyed hash salt is
+generated at `.ltl-salt` on first run; keep it stable to make runs and
+exports comparable, and treat it as a secret.
+
+## Export a replayable anonymized trace
+
+```bash
+# primary: bailian superset (16-token blocks, session structure, stream/status)
+llmtrafficlens export gateway.csv --to bailian -o trace.jsonl
+
+# downgrade: Mooncake four-field format
+llmtrafficlens export gateway.csv --to mooncake -o mooncake.jsonl
+```
+
+Replay examples:
+
+```bash
+# NVIDIA AIPerf (timestamped replay)
+aiperf profile --custom-dataset-type mooncake_trace --input-file mooncake.jsonl --fixed-schedule ...
+
+# SGLang bench_serving
+python -m sglang.bench_serving --dataset-name mooncake --dataset-path mooncake.jsonl ...
+```
+
+## Fit a load generator to your traffic
+
+```bash
+llmtrafficlens fit gateway.csv --target sglang-gsp
+```
+
+Emits `--gsp-*` arguments (group count, zipf alpha, prompt lengths) plus a
+**fidelity report**: the theoretical ECHR the synthetic config would
+produce vs your measured upper bound, so the flattening loss is explicit.
+
+## Reading the numbers
+
+- **ECHR upper bound** counts *cross-request* shared prefixes only, under
+  infinite cache / perfect routing / no eviction. Real deployments land
+  below it; intra-session reuse is invisible unless your sample carries
+  session identifiers.
+- **Session identifier presence 0%** means session-affinity routing cannot
+  capture any of the observed reuse — a prefix-aware policy is required.
+- Block size defaults to 16 tokens (qwen-bailian convention; finer and
+  engine-page aligned). Mooncake input implies 512.
+
+## Positioning
+
+Observability platforms (Langfuse, Helicone, Datadog LLM) stop at
+token/cost counting. Trace analyzers (Mooncake simulator, AIPerf
+`analyze-trace`) require pre-hashed traces. Simulators (Vidur,
+SplitwiseSim) consume traces nobody produces from production logs.
+`llmtrafficlens` covers the missing pipeline: **raw gateway logs →
+structural analysis → decision numbers → standard replayable trace**.
+
+## License
+
+Apache-2.0

llmtrafficlens-0.1.0/README.md

@@ -0,0 +1,125 @@
+# llmtrafficlens
+
+**LLM gateway traffic profiler** — analyze prefix-reuse structure in your
+gateway logs, estimate the prefix-cache hit-rate ceiling *before* you build
+KV-cache-aware routing, and export anonymized replayable traces in
+community-standard formats.
+
+Every KV-cache product tells you how much you saved *after* deployment.
+`llmtrafficlens` answers the prior question: **is your traffic worth it, and
+what is the upper bound?**
+
+## What it does
+
+1. **Traffic profile** — input/output token distributions, streaming ratio,
+   model mix, error rates.
+2. **Prefix structure** — distinct prefixes, shared-prefix groups, and a
+   **dual-metric leaderboard**: top prefixes *by reuse count* vs *by reusable
+   token volume*. The two heads routinely differ: a 15-token prefix reused
+   870× is worthless to a cache, a 19K-token prefix reused 95× dominates it.
+3. **Session-shape detection** — presence rate of session identifiers
+   (`prompt_cache_key`, `metadata.*`): tells you whether reuse is
+   *cross-request shared-prefix* shaped (needs prefix-aware routing) or
+   *intra-session* shaped (session affinity suffices).
+4. **Reuse potential** — ECHR (engine cache hit rate) upper bound under
+   infinite cache + perfect routing, plus an LRU capacity/hit-rate curve.
+5. **Anonymized export** — qwen-bailian-superset or Mooncake JSONL (salted
+   chained block hashes; no text leaves your machine), directly replayable
+   by NVIDIA AIPerf, SGLang bench_serving, and AIBrix.
+6. **Generator fitting** — emit SGLang `generated-shared-prefix` CLI args
+   (zipf popularity fitted to your histogram) with a fidelity report.
+
+## Install
+
+```bash
+pip install llmtrafficlens
+```
+
+Zero runtime dependencies. Python ≥ 3.10.
+
+## Quickstart on a public trace
+
+Validate the analyzer against the public [Mooncake
+trace](https://github.com/kvcache-ai/Mooncake) (FAST'25) — the result should
+match the official [KV Cache Hit Rate
+Simulator](https://kvcache.ai/tools/kv-cache-hit-rate-simulator/)'s
+infinite-capacity ceiling:
+
+```bash
+curl -LO https://raw.githubusercontent.com/kvcache-ai/Mooncake/main/FAST25-release/traces/conversation_trace.jsonl
+llmtrafficlens validate conversation_trace.jsonl --format mooncake
+llmtrafficlens profile  conversation_trace.jsonl --format mooncake -o mooncake-report
+```
+
+## Profile your own gateway logs
+
+Input: a CSV with a `request_json` column holding the OpenAI-format request
+body (optional `response_json`, `model_name`, `status_code` columns are
+picked up when present).
+
+```bash
+llmtrafficlens profile gateway.csv -o report
+# -> report.json + report.html
+```
+
+All processing is local. The report contains aggregates only — raw prompts
+never appear in any output.
+
+Token counts use a chars/4 approximation unless the log carries `usage`
+(then exact counts are used and marked in the report). A keyed hash salt is
+generated at `.ltl-salt` on first run; keep it stable to make runs and
+exports comparable, and treat it as a secret.
+
+## Export a replayable anonymized trace
+
+```bash
+# primary: bailian superset (16-token blocks, session structure, stream/status)
+llmtrafficlens export gateway.csv --to bailian -o trace.jsonl
+
+# downgrade: Mooncake four-field format
+llmtrafficlens export gateway.csv --to mooncake -o mooncake.jsonl
+```
+
+Replay examples:
+
+```bash
+# NVIDIA AIPerf (timestamped replay)
+aiperf profile --custom-dataset-type mooncake_trace --input-file mooncake.jsonl --fixed-schedule ...
+
+# SGLang bench_serving
+python -m sglang.bench_serving --dataset-name mooncake --dataset-path mooncake.jsonl ...
+```
+
+## Fit a load generator to your traffic
+
+```bash
+llmtrafficlens fit gateway.csv --target sglang-gsp
+```
+
+Emits `--gsp-*` arguments (group count, zipf alpha, prompt lengths) plus a
+**fidelity report**: the theoretical ECHR the synthetic config would
+produce vs your measured upper bound, so the flattening loss is explicit.
+
+## Reading the numbers
+
+- **ECHR upper bound** counts *cross-request* shared prefixes only, under
+  infinite cache / perfect routing / no eviction. Real deployments land
+  below it; intra-session reuse is invisible unless your sample carries
+  session identifiers.
+- **Session identifier presence 0%** means session-affinity routing cannot
+  capture any of the observed reuse — a prefix-aware policy is required.
+- Block size defaults to 16 tokens (qwen-bailian convention; finer and
+  engine-page aligned). Mooncake input implies 512.
+
+## Positioning
+
+Observability platforms (Langfuse, Helicone, Datadog LLM) stop at
+token/cost counting. Trace analyzers (Mooncake simulator, AIPerf
+`analyze-trace`) require pre-hashed traces. Simulators (Vidur,
+SplitwiseSim) consume traces nobody produces from production logs.
+`llmtrafficlens` covers the missing pipeline: **raw gateway logs →
+structural analysis → decision numbers → standard replayable trace**.
+
+## License
+
+Apache-2.0

llmtrafficlens-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "llmtrafficlens"
+version = "0.1.0"
+description = "LLM gateway traffic profiler: prefix-reuse analysis, cache-hit-rate upper bounds, and anonymized replayable trace export"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [{ name = "Jason Zhu" }]
+keywords = [
+  "llm", "kv-cache", "prefix-cache", "workload-characterization",
+  "traffic-analysis", "trace", "mooncake", "benchmark",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Topic :: System :: Benchmark",
+]
+dependencies = []
+
+[project.optional-dependencies]
+tokenizer = ["tokenizers>=0.15"]
+
+[project.scripts]
+llmtrafficlens = "llmtrafficlens.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/Belyenochi/llmtrafficlens"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/llmtrafficlens"]

llmtrafficlens-0.1.0/src/llmtrafficlens/__init__.py

@@ -0,0 +1,8 @@
+"""llmtrafficlens: LLM gateway traffic profiler.
+
+Analyzes request-level traffic shape and token-level prefix-reuse structure
+from raw gateway logs, estimates prefix-cache hit-rate upper bounds, and
+exports anonymized replayable traces in community-standard formats.
+"""
+
+__version__ = "0.1.0"