Skip to main content

Generate ElasticSearch templates from JSL

Project description

jsl_elasticsearch generates ElasticSearch mappings from JSL definitions.

It requires Python 3.4 or later (mainly for functools.singledispatch).

It is specifically aimed at use cases where ElasticSearch is being used as a time series database for JSON data with schemas defined using the jsl Python library.

The main API is jsl_elasticsearch.render_es_template:

def render_es_template(document, title, role, doc_type="content"):
    """Render an ElasticSearch time series template for given JSL document

    Template name is generated from the given *title* and *role*
    Document variables are resolved using the given *role*
    *doc_type* specifies the ElasticSearch mapping name (default: "content")
    """

The @timestamp field expected by Kibana is added automatically, and string fields are flagged as not_analyzed by default (so ElasticSearch treats them as opaque tokens, rather than as plain text fields to be analyzed for full text search)

The following JSL field types are currently supported:

  • jsl.StringField

  • jsl.NumberField

  • jsl.IntField

  • jsl.ArrayField

  • jsl.DictField

  • jsl.DocumentField

An additional field type is also defined:

  • jsl_elasticsearch.TextField

With string fields being flagged as opaque tokens by default, TextField is a new StringField subclass that flags the field for full text search in the ElasticSearch mapping, but is otherwise handled exactly like StringField by JSL.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsl-elasticsearch-0.1.dev0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

jsl_elasticsearch-0.1.dev0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file jsl-elasticsearch-0.1.dev0.tar.gz.

File metadata

File hashes

Hashes for jsl-elasticsearch-0.1.dev0.tar.gz
Algorithm Hash digest
SHA256 af4273c3c584710ab07428020d32bfdf9053e2e09a3bf50c3a924a5fc49a12ae
MD5 c157dd31035b34e208c4e53e39eb575c
BLAKE2b-256 e9815e8007538718881fd78627c5ec6fd9d411b67397ccc5b689eaf9595f1806

See more details on using hashes here.

File details

Details for the file jsl_elasticsearch-0.1.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for jsl_elasticsearch-0.1.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 717ce3a04c4b489a2c2000c2361ddff66da093e01d18c76c476cb9b564723b15
MD5 7c48d09998db7cf4f033de1afb0e0a09
BLAKE2b-256 90b0a1558f80716e5cf12ad951ffb0c23ddc032e312cb4ff75241ecbd6263659

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page