Mustash 0.3

Mustash, composed of “mu” meaning “mutation” and “stash” referencing Logstash, is a Python module for coding and applying transformations to a JSON document.

The project is present at the following locations:

• Mustash repository on Gitlab;

• Mustash project on PyPI.

The project’s code and documentation contents are licensed under CeCILL-C as distributed by the CEA, CNRS and Inria on cecill.info.

This documentation is organized using Diátaxis’ structure.

How-to guides

These sections provide guides, i.e. recipes, targeted towards various actors. They guide you through the steps involved in addressing key problems and use-cases.

• General guides
  • Installing Mustash
    • pip (generic)
  • Reporting a vulnerability or issue
    • Reporting a vulnerability
    • Reporting any other issue or evolution request
• Developer guides
  • Defining or reading pipelines
    • Gather an ingest pipeline from an ElasticSearch instance
    • Read a JSON document or blob representing an ingest pipeline
    • Read a pipeline from a Logstash configuration
    • Define a pipeline manually
  • Rendering pipelines
    • Install a pipeline on an ElasticSearch instance, as an ingest pipeline
    • Render a pipeline as an ElasticSearch ingest pipeline
    • Render a pipeline as a Logstash filter configuration
  • Creating processors
    • Creating field processors
    • Creating more complex processors
  • Validating ElasticSearch pipelines
  • Tweaking the ElasticSearch pipeline parser
    • Making your own parser instance
    • Creating a custom ElasticSearch processor

Discussion topics

These sections discuss key topics and concepts at a fairly high level, and provide useful background information and explanation.

• General topics
  • Concepts
    • Documents
    • Pipelines
    • Field paths

References

These sections provide technical reference for APIs and other aspects of Mustash’s machinery. They go into detail, and therefore, assume you have a basic understanding of key concepts.

• Code reference
  • mustash – main namespace for the project
    • mustash.core – Core definitions
    • mustash.es – ElasticSearch ingest pipeline conversion utilities
    • mustash.exc – Exception definitions
    • mustash.logstash – Logstash pipeline conversion utilities
    • mustash.processors – Built-in processors
    • mustash.time – Date and time format handlers
    • mustash.utils – Miscellaneous utilities
• Processor and conversion reference