Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Below is a table containing all of the configurable options within the Lens Writer. To see how to set config variables, see the Quick Start Guide or the full User Guide. Mandatory variables are highlighted in red.

...

Environment Variable

Default Value

Description

Version

FRIENDLY_NAME

Lens-Writer

The name you wish to set your Writer up with.

v1.3+

LICENSE

 

The License key provided required for running the Writer.

v1.3+

TRIPLESTORE_ENDPOINT

 

The endpoint for your Triple Store you wish to upload your RDF to.

v1.3+

TRIPLESTORE_TYPE

sparql

The Triple Store type, some graphs will support the default sparql type (e.g. AllegroGraph), however certain graphs require specific type declaration, these include graphdb, stardog, blazegraph, neptune, and neo4j.

v1.3+

TRIPLESTORE_REASONING

false

Whether you want reasoning enabled or disabled.

v1.3+

TRIPLESTORE_USERNAME

The username of your Triple Store. Leave blank if your Triple Store does not require any authentication.

v1.3+

TRIPLESTORE_PASSWORD

The password of your Triple Store. Leave blank if your Triple Store does not require any authentication.

v1.3+

S3_REGION

us-east-1

The region in AWS where your files and services reside. Note: all services must be in the same region.

v1.3+

AWS_ACCESS_KEY

 

Your access key for AWS.

v1.3+

AWS_SECRET_KEY

 

Your secret key for AWS.

v1.3+

DELETE_SOURCE

false

Whether you wish to delete the source NQuads file after it has been written to the Triple Store

v1.3+

LENS_RUN_STANDALONE

false

The Lens Writer is designed to run as part of a larger end to end system with the Lens providing the Writer with RDF files to write to a Triple Store. As part of this process, Kafka is used to communicate between services. This is enabled by default, however if you want to run the Lens Writer as standalone without communicating to other services, set this property to true.

v1.3+

INGESTION_MODE

insert

How to process the ingested data.

  • 'insert': the new data are ingested in full and are no linked with already existing data. The new dataset adds new value to already existing subject-predicate.

  • 'update': the new data are used for updating the existing data. The new dataset replaces value in existing subject-predicate.

v1.4+

...

Environment Variable

Default Value

Description

Version

RECORD_PROVO

false

Currently, the Lens Writer does not generate its own provenance meta-data and so this option is set to false

v1.3+

 

Logging Configuration

Environment Variable

Default Value

Description

Version

LOGGING_LEVEL

WARN

Global log level

v1.3+

LOGGING_LOGGERS_DATALENS

DEBUG

Log level for Data Lens loggers

v1.3+

LOGGING_LOGGERS_DROPWIZARD

INFO

Log level for Dropwizard loggers

v1.3+

LOGGING_APPENDERS_CONSOLE_TIMEZONE

UTC

Timezone for console logging

v1.3+

LOGGING_APPENDERS_TXT_FILE_THRESHOLD

ALL

Threashold for text logging

v1.3+

Log Format (not overridable)

%-6level [%d{HH:mm:ss.SSS}] [%t] %logger{5} - %X{code} %msg %n

Pattern for logging messages

v1.3+

Current Log Filename (not overridable)

/var/log/datalens/text/current/application_${applicationName}_${timeStamp}.txt.log

Pattern for log file name

v1.3+

LOGGING_APPENDERS_TXT_FILE_ARCHIVE

true

Archive log text files

v1.3+

Archived Log Filename Pattern (not overridable)

/var/log/datalens/text/archive/application_${applicationName}_${timeStamp}_to_%d{yyyy-MM-dd}.txt.log

Log file rollover frequency depends on pattern in following property. For example %d{yyyy-MM-ww} declares rollover weekly

v1.3+

LOGGING_APPENDERS_TXT_FILE_ARCHIVED_TXT_FILE_COUNT

7

Max number of archived text files

v1.3+

LOGGING_APPENDERS_TXT_FILE_TIMEZONE

UTC

Timezone for text file logging

v1.3+

LOGGING_APPENDERS_JSON_FILE_THRESHOLD

ALL

Threashold for text logging

v1.3+

Log Format (not overridable)

%-6level [%d{HH:mm:ss.SSS}] [%t] %logger{5} - %X{code} %msg %n

Pattern for logging messages

v1.3+

Current Log Filename (not overridable)

/var/log/datalens/json/current/application_${applicationName}_${timeStamp}.json.log

Pattern for log file name

v1.3+

LOGGING_APPENDERS_JSON_FILE_ARCHIVE

true

Archive log text files

v1.3+

Archived Log Filename Pattern (not overridable)

/var/log/datalens/json/archive/application_${applicationName}_${timeStamp}_to_%d{yyyy-MM-dd}.json.log

Log file rollover frequency depends on pattern in following property. For example %d{yyyy-MM-ww} declares rollover weekly

v1.3+

LOGGING_APPENDERS_JSON_FILE_ARCHIVED_FILE_COUNT

7

Max number of archived text files

v1.3+

LOGGING_APPENDERS_JSON_FILE_TIMEZONE

UTC

Timezone for text file logging

v1.3+

LOGGING_APPENDERS_JSON_FILE_LAYOUT_TYPE

json

The layout type for the json logger

v1.3+

...