log10x-mcp 1.12.9 → 1.12.10

package/build/product-kb/docs/api/compile.md

@@ -0,0 +1,32 @@
+---
+icon: material/cogs
+---
+
+Compile integrations provide an extensible mechanism for extracting [symbol](https://doc.log10x.com/compile/scan/) values from new source code language, text and binary formats using industry standard Java frameworks.
+
+To specify .jar files to dynamically load into the host JVM see the [jarfiles](https://doc.log10x.com/compile/bootstrap/#jarfiles) argument.
+
+## :material-code-tags: ANTLR
+
+The [ANTLR](https://www.antlr.org/){target="\_blank"} integration enables the [ANTLR scanner](https://doc.log10x.com/compile/scanner/antlr/) to extract symbol values from a variety of source code languages.
+
+:simple-yaml: Config example: [config/javascript.yaml](https://github.com/log-10x/config/blob/main/pipelines/compile/modules/scan/antlr/config/javascript.yaml){target="\_blank"}.
+
+:fontawesome-brands-java: Code example: [Parser tutorial](https://www.baeldung.com/java-antlr){target="\_blank"}.
+
+
+## :material-xml: Jackson
+
+The [Jackson](https://github.com/FasterXML/jackson){target="\_blank"} integration enables the [text scanner](https://doc.log10x.com/compile/scanner/text) to extract symbol values from a variety of text and binary formats.
+
+:simple-yaml: Config example: [config/jackson.yaml](https://github.com/log-10x/config/blob/main/pipelines/compile/modules/scan/text/config/jackson.yaml){target="\_blank"}.
+
+## :material-console: Executable
+
+The [executable](https://doc.log10x.com/compile/scanner/executable) integration allows for extracting symbol values from external sources by reading [un/structured](https://doc.log10x.com/compile/scan/scanner/#structured) symbol and context values from an OS/custom subprocess's stdout device. 
+
+This integration does not make any assumptions about the language in which a subprocess from which information is read is written in.
+
+:simple-yaml: Config example: [executable/strings.yaml](https://github.com/log-10x/config/blob/main/pipelines/compile/modules/scan/executable/config/strings.yaml){target="\_blank"}.
+
+:fontawesome-brands-java: Code example: [SymbolUnit.java](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/compile/symbol/SymbolUnit.java){target="\_blank"}.

package/build/product-kb/docs/api/expand.md

@@ -0,0 +1,24 @@
+---
+icon: material/arrow-expand-all
+title: "Expand Libraries"
+---
+
+# Expand Libraries
+
+Open-source libraries for expanding [compact](https://doc.log10x.com/run/transform/#compact) events produced by the [Receiver (Compact mode)](https://doc.log10x.com/apps/receiver/). Each library expands events from compact form by resolving templates and substituting variable values — the reverse of the compact step performed at the edge.
+
+## :material-language-java: Java Decoder
+
+The Java decoder is used by platform plugins that need to expand compact events within JVM-based search and analytics engines. The [:simple-elasticsearch: L1ES plugin for Elasticsearch](https://doc.log10x.com/apps/receiver/compact/elasticsearch/) uses this library to transparently expand compact events at query time, so Kibana dashboards, searches, and alerts work unchanged on optimized data.
+
+<div style="display: flex; justify-content: center; align-items: center; gap: 12px; flex-wrap: wrap;" markdown>
+[:material-github: log10x-decoder-java](https://github.com/log-10x/log10x-decoder-java){ .md-button target="_blank" }
+</div>
+
+## :material-language-javascript: JavaScript Decoder
+
+The JavaScript decoder is used by the [:material-web: Console app](https://doc.log10x.com/manage/app/) to expand compact events within its Dev CLI interface — the same tabbed event viewer (Raw, Template, Variables, Pattern) shown on the [Dev app page](https://doc.log10x.com/apps/dev/). When the Console renders processed events, the JS decoder expands them client-side for display.
+
+<div style="display: flex; justify-content: center; align-items: center; gap: 12px; flex-wrap: wrap;" markdown>
+[:material-github: log10x-decoder-js](https://github.com/log-10x/log10x-decoder-js){ .md-button target="_blank" }
+</div>

package/build/product-kb/docs/api/extend/index.md

@@ -0,0 +1,42 @@
+---
+icon: material/puzzle-outline
+title: Extend
+---
+
+Java extensibility framework for adding custom launchers, compilers, inputs, and outputs.
+
+<div class="grid cards" markdown>
+
+-   :material-rocket-launch-outline:{ .lg .middle } __Launch__
+
+    ---
+
+    Launch the engine via CLI, serverless functions, k8s charts, and more.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/launch/)
+
+-   :material-cogs:{ .lg .middle } __Compile__
+
+    ---
+
+    Extract symbols from new source code languages, text, and binary formats.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/compile/)
+
+-   :material-set-merge:{ .lg .middle } __Input__
+
+    ---
+
+    Read events from custom analyzers, forwarders, and object storage sources.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/input/)
+
+-   :material-set-split:{ .lg .middle } __Output__
+
+    ---
+
+    Write TenXObjects and summaries to event and metric destinations.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/output/)
+
+</div>

package/build/product-kb/docs/api/github.md

@@ -0,0 +1,129 @@
+---
+icon: material/github
+---
+
+# GitHub Repositories
+
+Repositories in the [log-10x](https://github.com/log-10x){target="_blank"} org are organized by the [App Guide](https://doc.log10x.com/apps/) adoption sequence — from compiling symbols and local testing, through cloud cost reporting, to edge optimization and data lake streaming.
+
+<div style="text-align: center;">
+
+```mermaid
+graph LR
+    A["⚙️ Compiler<br/>Generate Symbols"] --> B["💻 Dev<br/>Test Locally"]
+    B --> C["📊 Reporter<br/>Analyze Costs (DaemonSet)"]
+    C --> D["⚡ Receiver<br/>Filter or Compact @ Source"]
+    D --> E["☁️ Retriever<br/>S3 Data Lake"]
+
+    classDef compiler fill:#6366f1,stroke:#4f46e5,color:#ffffff,stroke-width:2px,rx:8,ry:8
+    classDef dev fill:#8b5cf6,stroke:#7c3aed,color:#ffffff,stroke-width:2px,rx:8,ry:8
+    classDef reporter fill:#06b6d4,stroke:#0891b2,color:#ffffff,stroke-width:2px,rx:8,ry:8
+    classDef edge fill:#10b981,stroke:#059669,color:#ffffff,stroke-width:2px,rx:8,ry:8
+    classDef cloud fill:#f59e0b,stroke:#d97706,color:#ffffff,stroke-width:2px,rx:8,ry:8
+
+    class A compiler
+    class B dev
+    class C reporter
+    class D edge
+    class E cloud
+```
+
+</div>
+
+## :material-table-search: Quick Reference
+
+| I want to...                              | Repos                                                 |
+|-------------------------------------------|-------------------------------------------------------|
+| Evaluate locally                          | [pipeline-releases] · [config]                        |
+| Deploy edge with any forwarder            | [config] + your forwarder's upstream chart — see the [Receiver deployment guide](https://doc.log10x.com/apps/receiver/deploy/) |
+| Stream logs to S3                         | [helm-charts] · [terraform-aws-tenx-retriever-infra]   |
+| Search compact events in Splunk           | [splunk-app]                                          |
+| Search compact events in Elasticsearch    | [elasticsearch-plugin]                                |
+| Manage config as GitOps                   | [gitops-demo] · [config]                              |
+
+---
+
+## :material-download: Install & Configure
+
+Get the engine, clone the config workspace, and start exploring.
+
+| Repo | Purpose |
+|------|---------|
+| [pipeline-releases] | Engine binaries and install scripts |
+| [config] | Your working directory — apps, pipelines, data templates |
+| [modules] | Pre-built app and pipeline definitions (reference) |
+| [docker-images] | Container images for the engine |
+
+**Docs:** [Install Guide](https://doc.log10x.com/install/) · [Config Reference](https://doc.log10x.com/config/) · [Compiler](https://doc.log10x.com/compile/) · [Dev](https://doc.log10x.com/apps/dev/) · [Reporter](https://doc.log10x.com/apps/reporter/) · [MCP](https://doc.log10x.com/apps/)
+
+---
+
+## :material-upload-network-outline: In-Cluster Deployment
+
+Deploy 10x apps to your Kubernetes cluster on top of your forwarder's **upstream** Helm chart — a values overlay adds the 10x sidecar (or, for Filebeat, swaps the image to `log10x/filebeat-10x`). The Reporter runs as a DaemonSet alongside your forwarder; the Receiver runs as a sidecar in the forwarder path.
+
+| Forwarder | Upstream chart |
+|-----------|----------------|
+| Fluentd | `fluent/fluentd` |
+| Fluent Bit | `fluent/fluent-bit` |
+| Filebeat | `elastic/filebeat` (image swap to `log10x/filebeat-10x`) |
+| Logstash | `elastic/logstash` |
+| OpenTelemetry Collector | `open-telemetry/opentelemetry-collector` |
+| Vector | `vector/vector` |
+
+The full per-forwarder values overlay (license wiring, sidecar injection, return-path config) lives in the [Receiver deployment guide](https://doc.log10x.com/apps/receiver/deploy/) and the [Reporter deployment guide](https://doc.log10x.com/apps/reporter/deploy/).
+
+**Docs:** [Reporter](https://doc.log10x.com/apps/reporter/) · [Receiver](https://doc.log10x.com/apps/receiver/) (Filter and Compact modes)
+
+---
+
+## :material-cloud-arrow-right-outline: Retriever
+
+Store optimized logs in S3 and query on-demand. Provision infrastructure with Terraform, deploy with Helm.
+
+| Repo | Purpose |
+|------|---------|
+| [helm-charts] | Helm charts for Retriever and Cron pipelines |
+| [terraform-aws-tenx-retriever-infra] | Terraform: SQS queues + S3 indexing infrastructure |
+| [terraform-aws-tenx-retriever] | Terraform: Retriever application deployment |
+
+**Docs:** [Retriever Guide](https://doc.log10x.com/apps/retriever/)
+
+---
+
+## :material-puzzle-outline: Extensions & Integrations
+
+| Repo | Purpose |
+|------|---------|
+| [pipeline-extensions] | Java extensions: custom inputs, outputs, scanners |
+| [splunk-app] | Splunk app — search/visualize compact events with zero data loss |
+| [elasticsearch-plugin] | Elasticsearch/OpenSearch plugin — transparent query rewriting and _source expansion for compact events |
+| [log10x-decoder-java] | Java library for expanding compact events in JVM applications and pipelines |
+| [log10x-decoder-js] | JavaScript library for expanding compact events in Node.js and browser environments |
+| [prometheus-remote-write] | Push 10x metrics to Prometheus via remote write protocol |
+
+---
+
+## :material-source-branch: GitOps & Operations
+
+| Repo | Purpose |
+|------|---------|
+| [gitops-demo] | Example: manage Log10x config as code with GitOps |
+| [status] | [status.log10x.com](https://status.log10x.com){target="_blank"} — uptime monitoring |
+
+
+[pipeline-releases]: https://github.com/log-10x/pipeline-releases "log-10x/pipeline-releases"
+[config]: https://github.com/log-10x/config "log-10x/config"
+[modules]: https://github.com/log-10x/modules "log-10x/modules"
+[docker-images]: https://github.com/log-10x/docker-images "log-10x/docker-images"
+[pipeline-extensions]: https://github.com/log-10x/pipeline-extensions "log-10x/pipeline-extensions"
+[helm-charts]: https://github.com/log-10x/helm-charts "log-10x/helm-charts"
+[terraform-aws-tenx-retriever-infra]: https://github.com/log-10x/terraform-aws-tenx-retriever-infra "log-10x/terraform-aws-tenx-retriever-infra"
+[terraform-aws-tenx-retriever]: https://github.com/log-10x/terraform-aws-tenx-retriever "log-10x/terraform-aws-tenx-retriever"
+[splunk-app]: https://github.com/log-10x/splunk-app "log-10x/splunk-app"
+[elasticsearch-plugin]: https://github.com/log-10x/elasticsearch-plugin "log-10x/elasticsearch-plugin"
+[prometheus-remote-write]: https://github.com/log-10x/prometheus-remote-write "log-10x/prometheus-remote-write"
+[log10x-decoder-java]: https://github.com/log-10x/log10x-decoder-java "log-10x/log10x-decoder-java"
+[log10x-decoder-js]: https://github.com/log-10x/log10x-decoder-js "log-10x/log10x-decoder-js"
+[gitops-demo]: https://github.com/log-10x/gitops-demo "log-10x/gitops-demo"
+[status]: https://github.com/log-10x/status "log-10x/status"

package/build/product-kb/docs/api/index.md

@@ -0,0 +1,42 @@
+---
+icon: material/code-tags
+title: API
+---
+
+The 10x Engine offers a wide array of APIs for adding new capabilities and integrations during both the compile and run phases.
+
+<div class="grid cards" markdown>
+
+-   :material-language-javascript:{ .lg .middle } __Library__
+
+    ---
+
+    Enrich, aggregate, and filter TenXObjects at runtime using the TenX JavaScript library.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/js/)
+
+-   :material-api:{ .lg .middle } __REST__
+
+    ---
+
+    Manage accounts, query metrics, and track license usage via REST endpoints.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/rest/)
+
+-   :material-puzzle-outline:{ .lg .middle } __Extend__
+
+    ---
+
+    Java extensibility framework for custom launchers, compilers, inputs, and outputs.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/extend/)
+
+-   :material-github:{ .lg .middle } __GitHub__
+
+    ---
+
+    Public repositories for configuration, modules, Helm charts, and extensions.
+
+    [:octicons-arrow-right-24: Learn more](https://doc.log10x.com/api/github/)
+
+</div>

package/build/product-kb/docs/api/input.md

@@ -0,0 +1,35 @@
+---
+icon: material/set-merge
+---
+
+Input integrations provide an extensible mechanisms for reading log/trace events from new [analyzer](https://doc.log10x.com/run/input/analyzer/), [forwarder](https://doc.log10x.com/run/input/forwarder/) and [object storage](https://doc.log10x.com/run/input/objectStorage/) sources using industry standard Java frameworks.
+
+To specify .jar files to dynamically load into the host JVM see the [jarfiles](https://doc.log10x.com/run/bootstrap/#jarfiles) argument.
+
+## :fontawesome-brands-java: InputStream
+
+The [I/O Streams](https://docs.oracle.com/javase/tutorial/essential/io/streams.html){target="\_blank"} integration enables reading log/trace events from arbitrary sources via custom [InputStream](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html){target="\_blank"}  and [Reader](https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html){target="\_blank"}  classes.
+
+For example, the [CamelContextInputStream](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/camel/CamelContextInputStream.java) class
+reads data from over 400+ sources via [Apache Camel](https://camel.apache.org/components/), while the [IndexFilterWriter](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/index/write/IndexFilterWriter.java) class generates Bloom filters from TenXObject variable and template information. 
+ 
+:simple-yaml: Config example: [query/stream.yaml](https://github.com/log-10x/config/blob/main/pipelines/run/modules/input/objectStorage/query/stream.yaml){target="\_blank"}.
+
+:fontawesome-brands-java: Code example: [IndexQueryReader.java](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/index/query/IndexQueryReader.java){target="\_blank"}.
+
+## :simple-apache: Apache Camel
+
+The [Apache Camel](https://camel.apache.org){target="\_blank"} integration enables [analyzer](https://doc.log10x.com/run/input/analyzer/#extensibility) inputs to read events into the 10x Engine from 400+ data sources using declarative [YAML routes](https://camel.apache.org/manual/routes.html){target="\_blank"}.
+
+:simple-yaml: Config example: [splunk/route.yaml](https://github.com/log-10x/config/blob/main/pipelines/run/modules/input/analyzer/splunk/route.yaml){target="\_blank"}.
+
+:fontawesome-brands-java: Code example: [CamelContextInputStream.java](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/camel/CamelContextInputStream.java){target="\_blank"}.
+
+## :material-cloud-upload-outline: Object Storage
+
+The [object storage](https://doc.log10x.com/run/input/objectStorage/#storage-access) integration enables inputs to index and query events matching specified criteria into from an arbitrary blob storage (e.g., AWS S3, Azure blobs) by implementing the [ObjectStorageIndexAccessor](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/index/interfaces/ObjectStorageIndexAccessor.java){target="\_blank"} interface.
+
+:simple-yaml: Config example: [objectStorage/settings.yaml](https://github.com/log-10x/config/blob/main/pipelines/run/modules/input/objectStorage/settings.yaml){target="\_blank"}.
+
+:fontawesome-brands-java: Code example: [AWSIndexAccess.java](https://github.com/log-10x/pipeline-extensions/blob/main/cloud-extensions/src/main/java/com/log10x/ext/cloud/index/access/AWSIndexAccess.java)
+