Skip to content

Dev Output

Generates a shareable Log10x Console URL from dev app analysis results.

When the pipeline completes, this output builds a compact JSON payload from aggregated TenXSummary data, templates and encoded events, then compresses it into a URL that opens the Console with cost analysis, top patterns and volume reduction proof.

How It Works

Two output entries share a single DevOutputStream instance via the group mechanism:

  1. Summary (isSummary) — receives aggregated enrichment fields with summaryVolume and summaryBytes
  2. Event (isObject || isEncoded) — receives templateHash, template body and encode() values

On close, the stream produces:

  • A console URL with the analysis embedded (printed to console)
  • Optionally auto-opens the URL in the default browser
  • Optionally writes the raw JSON to a file

Memory usage is bounded by the number of unique templates, not the number of events.

Config Files

To configure the Dev output module, Edit these files.

Below is the default configuration from: dev/config.yaml.

Edit Online

Edit config.yaml Locally

# 🔟❎ 'run' dev analysis output configuration

# Configure the dev output to generate a shareable console URL from analysis results.
# To learn more see https://doc.log10x.com/run/output/event/dev

# Set the 10x pipeline to 'run'
tenx: run

# =============================== Dependencies ================================

include:
  - run/modules/output/event/dev

# ============================== Dev Output Options ============================

devOutput:

    # 'enabled' controls whether to generate a console URL from analysis results
  - enabled: true

    # 'openBrowser' auto-opens the console URL in the default browser
    openBrowser: true

    # 'localOnly' outputs JSON to console without generating a URL.
    #  Use for privacy when you prefer not to generate an external URL.
    localOnly: false

    # 'baseUrl' sets the base URL of the console viewer
    baseUrl: https://console.log10x.com

    # 'sourceName' sets the display name of the input log source in the console viewer
    sourceName: your logs

    # 'dailyGb' sets the estimated daily log volume in GB for ROI projections.
    #  Adjust to match your environment's actual daily log volume.
    dailyGb: 100

    # 'filePath' specifies a path on disk to write the analysis JSON.
    #  If not specified, the JSON is only encoded into the URL.
    # filePath:

    # 'topPatterns' sets the number of top log patterns (by bytes) to include
    topPatterns: 10

    # 'vrTemplates' sets the number of template samples for volume reduction proof
    vrTemplates: 10

    # 'vrEventsPerTemplate' sets the number of encoded event samples per template
    vrEventsPerTemplate: 1

Options

Specify the options below to configure multiple Dev output:

Name Description Category
devOutputEnabled Enable/disable dev output Dev
devOutputBaseUrl Base URL of the console viewer Dev
devOutputOpenBrowser Auto-open results in browser Dev
devOutputLocalOnly Local-only mode, output JSON without generating a URL Dev
devOutputFilePath File path to write JSON output Dev
devOutputSourceName Display name of the input log source Dev
devOutputDailyGb Estimated daily log volume in GB for ROI projections Dev
devOutputTopPatterns Number of top patterns to include by bytes Advanced
devOutputVrTemplates Number of templates to include in volume reduction samples Advanced
devOutputVrEventsPerTemplate Number of encoded events per template in volume reduction samples Advanced

Dev

devOutputEnabled

Enable/disable dev output.

Type Default Category
Boolean true Dev

Controls whether to generate a shareable console URL from the analysis results.

devOutputBaseUrl

Base URL of the console viewer.

Type Default Category
String https://console.log10x.com Dev

Specifies the base URL of the Log10x Console used to view results.

devOutputOpenBrowser

Auto-open results in browser.

Type Default Category
Boolean false Dev

If true, automatically opens the generated console URL in the default browser when the pipeline completes.

devOutputLocalOnly

Local-only mode, output JSON without generating a URL.

Type Default Category
Boolean false Dev

If true, outputs the analysis JSON to the console without generating or opening a URL. Use this for privacy when you prefer not to generate an external URL.

devOutputFilePath

File path to write JSON output.

Type Default Category
File Dev

Specifies a path on disk to write the analysis JSON. If not specified, the JSON is only printed to console (in local mode) or encoded into the URL.

devOutputSourceName

Display name of the input log source.

Type Default Category
String your logs Dev

Specifies the display name of the input log source shown in the console viewer.

devOutputDailyGb

Estimated daily log volume in GB for ROI projections.

Type Default Category
Number 100 Dev

Specifies an estimated daily log volume in gigabytes. The console viewer uses this value to project cost savings and ROI. Adjust to match your environment's actual daily log volume.

Advanced

devOutputTopPatterns

Number of top patterns to include by bytes.

Type Default Category
Number 10 Advanced

Sets the number of top log patterns (by bytes) to include in the output.

devOutputVrTemplates

Number of templates to include in volume reduction samples.

Type Default Category
Number 10 Advanced

Sets the number of template samples to include for the volume reduction proof dialog in the console viewer. Templates are selected by reduction ratio (compact size vs original size) weighted by frequency.

devOutputVrEventsPerTemplate

Number of encoded events per template in volume reduction samples.

Type Default Category
Number 1 Advanced

Sets the number of encoded event samples to include per template for the volume reduction proof dialog.


This module is defined in dev/module.yaml.