---
title: "Compile"
description: "scan source code and binary files to generate symbol unit and library\
  \ files"
source: "https://github.com/log-10x/modules/tree/main/pipelines/compile/pipeline.yaml"
icon: "material/cogs"

---
The `AOT compile` pipeline produces [symbol library](https://doc.log10x.com/compile/link/#symbol-library) files that enable the [run](https://doc.log10x.com/run/) stream processor pipeline to transform input events into typed [TenXObjects](https://doc.log10x.com/api/js/#TenXObject "Provide structured, reflective access to log/trace events read from input(s)."). To launch this pipeline use the [compiler app](https://doc.log10x.com/apps/compiler/).

The 10x Engine's [default library](https://doc.log10x.com/compile/pull/#default-symbols) covers 150+ frameworks. Running the compiler on your own environment's repos is **optional** and enables the runtime to increase its level of efficiency in aggregating and reducing event volume.

## :material-cog-transfer-outline: Workflow

This pipeline chains together the following key [units](https://doc.log10x.com/engine/pipeline/#units):

<div style="text-align: center;">

```mermaid
graph LR
    A["<div style='font-size: 14px;'>📥 Pull</div><div style='font-size: 10px; text-align: center;'>Fetch Sources</div>"] --> B["<div style='font-size: 14px;'>🔍 Scan</div><div style='font-size: 10px; text-align: center;'>Extract Symbols</div>"]
    B --> C["<div style='font-size: 14px;'>🔗 Link</div><div style='font-size: 10px; text-align: center;'>Build Library</div>"]
    C --> D["<div style='font-size: 14px;'>📤 Push</div><div style='font-size: 10px; text-align: center;'>Commit Output</div>"]
    
    classDef pull fill:#2563eb88,stroke:#1d4ed8,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef scan fill:#059669,stroke:#047857,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef link fill:#ea580c88,stroke:#c2410c,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef push fill:#16a34a88,stroke:#15803d,color:#ffffff,stroke-width:2px,rx:8,ry:8
    
    class A pull
    class B scan
    class C link
    class D push
```

</div>

<div class="grid cards" markdown>

-   :material-source-pull:{ .lg .middle } **Pull**
    
    ___
    
    [Pull](https://doc.log10x.com/compile/pull/ "Pull input source code/binary files from remote repositories") input files from local disk and remote repos as well as existing symbol files to reuse.

-   :material-file-code-outline:{ .lg .middle } **Scan**
    
    ___
    
    [Scan](https://doc.log10x.com/compile/scan/ "Capture symbol values from source code/binary files and link to an output symbol library") input files in an array of programming languages, text, and binary formats to produce symbol unit files.

-   :material-merge:{ .lg .middle } **Link**
    
    ___
    
    [Link](https://doc.log10x.com/compile/link/ "Link symbol unit files to an output symbol library file") symbol unit files into a symbol library artifact for runtime use.

-   :material-source-commit:{ .lg .middle } **Push**
    
    ___
    
    [Push](https://doc.log10x.com/compile/push/ "Push output symbol unit files to GitHub") output files to GitHub for use by subsequent _run_ and _compile_ pipelines.

</div>

### :material-source-pull: Pull

[Pull](https://doc.log10x.com/compile/pull/ "Pull input source code/binary files from remote repositories") existing symbol units, source code, and binary input files from [GitHub ](https://doc.log10x.com/compile/pull/github/ "Pull folders from GitHub repositories to scan for symbol content"),
[Helm](https://doc.log10x.com/compile/pull/helm/ "Pull GitHub repositories and Docker images to scan for symbol content from Helm charts"), [Docker](https://doc.log10x.com/compile/pull/docker/ "Pull Docker image files to scan for symbol content") and [Artifactory](https://doc.log10x.com/compile/pull/artifactory/ "Pull files from Artifactory repositories to scan for symbol content") repos.
Pulling symbol units produced by previous invocations of the compile pipeline enables reuse to
avoid parsing previously processed source code/binary input files whose checksum has not changed.

### :material-file-code-outline: Scan

[Scan](https://doc.log10x.com/compile/scan/ "Capture symbol values from source code/binary files and link to an output symbol library") input files to extract [symbol](https://doc.log10x.com/run/transform/structure/#symbols) tokens representing low-cardinality values
shared across instances of a logical app/infra event originating from a source code location/binary executable.
They are analogous to compiled artifacts (e.g., .jar, .so) and are GitHub/Artifactory committable.

This phase utilizes a configurable set of [scanner](https://doc.log10x.com/compile/scan/ "Capture symbol values from source code/binary files and link to an output symbol library") modules to parse input files in various formats.

### :material-merge: Link

[Link](https://doc.log10x.com/compile/link/ "Link symbol unit files to an output symbol library file") symbol units into a single output Symbol library file to generate shared [TenXTemplate](https://doc.log10x.com/run/template/#structure) schemas at runtime for input events.

This phase is analogous to a [linker](<https://en.wikipedia.org/wiki/Linker_(computing)>){target="\_blank"} that
takes one or more object files (i.e., symbol units) and combines them into a single library file.

### :material-source-commit: Push

[Push](https://doc.log10x.com/compile/push/ "Push output symbol unit files to GitHub") output symbol files to a target GitHub repo for reuse
by subsequent compile invocations and for cloud/edge apps at runtime from a central configuration repository.

<br/>:material-github: This pipeline is defined in [compile/pipeline.yaml](https://github.com/log-10x/modules/tree/main/pipelines/compile/pipeline.yaml "compile/pipeline.yaml"){target="\_blank"}.