Metadata-Version: 2.1
Name: delog
Version: 0.0.8
Summary: client for centralized logging on a delog server
Home-page: https://github.com/plurid/delog
Author: ly3xqhl8g9
Author-email: ly3xqhl8g9@plurid.com
License: UNKNOWN
Description: <p align="center">
            <img src="https://raw.githubusercontent.com/plurid/delog/master/about/identity/delog-logo.png" height="250px">
            <br />
            <br />
            <a target="_blank" href="https://github.com/plurid/delog/blob/master/LICENSE">
                <img src="https://img.shields.io/badge/license-DEL-blue.svg?colorB=1380C3&style=for-the-badge" alt="License: DEL">
            </a>
        </p>
        
        
        
        <h1 align="center">
            delog
        </h1>
        
        
        <h3 align="center">
            Cloud Service for Centralized Logging
        </h3>
        
        
        
        `delog` is a [service](https://delog.plurid.cloud) or self-hosted logger.
        
        `delog` is intended to be:
        
        + centralized, single logging space for multi-project/multi-package software systems;
        + log-based testing controller;
        + warn/error notifier.
        
        `delog` has clients for:
        
        + [`CLI`][delog-client-cli];
        + [`NodeJS`][delog-client-javascript];
        + [`Python`][delog-client-python].
        
        The [`delog-server`][delog-server] uses [plurid](https://github.com/plurid/plurid) to explore information as a 3D structure.
        
        
        <p align="center">
            <img src="https://raw.githubusercontent.com/plurid/delog/master/about/screenshots/screenshot-1.png" height="500px">
        </p>
        
        <p align="center">
            analytics
        </p>
        
        
        <p align="center">
            <img src="https://raw.githubusercontent.com/plurid/delog/master/about/screenshots/screenshot-2.png" height="500px">
        </p>
        
        <p align="center">
            projects
        </p>
        
        
        <p align="center">
            <a target="_blank" href="https://youtu.be/q6PLf5k1HVM">
                <img src="https://raw.githubusercontent.com/plurid/delog/master/about/screenshots/screenshot-3.png" height="500px">
            </a>
        </p>
        
        <p align="center">
            exploration to log source
        </p>
        
        
        
        ### Contents
        
        + [About](#about)
        + [Client](#client)
            + [Support](support)
            + [Configuration](configuration)
        + [Server](#server)
            + [Building](building)
            + [Testing](testing)
        + [Packages](#packages)
        + [Codeophon](#codeophon)
        
        
        
        ## About
        
        `delog` acts as a central logging service. Once configured with a `token`, the `delog` client can point to the network `endpoint`, passing the `token`.
        
        `delog` can also function as a log-based tester. The `delog` client is set in the testing mode and a `delog` client call will trigger a `tester` in the `delog` endpoint.
        
        
        
        ## Client
        
        ### Support
        
        `delog` has client support for
        
        + [`CLI`][delog-client-cli]
        + [`NodeJS`][delog-client-javascript]
        + [`Python`][delog-client-python]
        
        
        ### Configuration
        
        The following environment variables can be set
        
        ```
        // quiets the delog's error reporting
        DELOG_QUIET = true | false
        
        // any delog will be checked against this level
        DELOG_GROUND_LEVEL = 0-7 | trace-fatal
        
        // format string, default '%TIME %TEXT'
        DELOG_FORMAT = string
        
        // delog server endpoint
        DELOG_ENDPOINT = string
        // delog server token
        DELOG_TOKEN = string
        
        // project name
        DELOG_PROJECT = string
        // space name
        DELOG_SPACE = string
        
        
        // calling details
        DELOG_CALL_CONTEXT = true | false
        DELOG_REPOSITORY_PROVIDER = string
        DELOG_REPOSITORY_NAME = string
        DELOG_REPOSITORY_COMMIT = string
        DELOG_REPOSITORY_BRANCH = string
        DELOG_REPOSITORY_BASEPATH = string
        ```
        
        
        
        ## Server
        
        ### Building
        
        ```
        docker build \
            -t delog-server \
            -f ./configurations/production.dockerfile \
            --build-arg PORT=56965 \
            --build-arg DELOG_ENDPOINT_GRAPHQL=/ \
            --build-arg DELOG_DATABASE_TYPE=mongo \
            --build-arg DELOG_LOG_LEVEL=0 \
            --build-arg DELOG_QUIET=false \
            --build-arg DELOG_CUSTOM_LOGIC_USAGE=false \
            --build-arg DELOG_PRIVATE_USAGE=true \
            --build-arg DELOG_PRIVATE_OWNER_IDENTONYM=identonym \
            --build-arg DELOG_PRIVATE_OWNER_KEY=key \
            --build-arg DELOG_PRIVATE_TOKEN=secret-token \
            --build-arg DELOG_MONGO_USERNAME=admin \
            --build-arg DELOG_MONGO_PASSWORD=1234 \
            --build-arg DELOG_MONGO_ADDRESS=localhost:56966 \
            --build-arg DELOG_MONGO_CONNECTION_STRING= \
            --build-arg DELOG_TEST_MODE=true \
            --build-arg DELOG_OPTIMIZATION_BATCH_WRITE_SIZE=1000 \
            --build-arg DELOG_OPTIMIZATION_BATCH_WRITE_TIME=2000 \
            .
        ```
        
        Run the container with `--network="host"` if running the database on the same host.
        
        ```
        docker run \
            --network="host" \
            -d delog-server
        ```
        
        Or run on a custom port (`8855`)
        
        ```
        docker run \
            -d -p 8855:56965 \
            delog-server
        ```
        
        
        ### Testing
        
        The `delog server` can use MongoDB as a database. For testing purposes, mongo can run in a docker container.
        
        ```
        docker pull mongo
        ```
        
        ```
        docker run -d --name mongo-delog \
            -p 56966:27017 -e MONGO_INITDB_ROOT_USERNAME=admin \
            -e MONGO_INITDB_ROOT_PASSWORD=1234 mongo
        ```
        
        Connect to the mongo instance with
        
        ```
        mongodb://admin:1234@localhost:56966/?authSource=admin
        ```
        
        to verify the connection.
        
        
        
        ## Packages
        
        <a target="_blank" href="https://www.npmjs.com/package/@plurid/delog-server">
            <img src="https://img.shields.io/npm/v/@plurid/delog-server.svg?logo=npm&colorB=1380C3&style=for-the-badge" alt="Version">
        </a>
        
        [@plurid/delog-server][delog-server] • the server application
        
        [delog-server]: https://github.com/plurid/delog/tree/master/packages/delog-server
        
        
        <a target="_blank" href="https://www.npmjs.com/package/@plurid/delog-cli">
            <img src="https://img.shields.io/npm/v/@plurid/delog-cli.svg?logo=npm&colorB=1380C3&style=for-the-badge" alt="Version">
        </a>
        
        [@plurid/delog-client-cli][delog-client-cli] • the `Command-Line Interface` client
        
        [delog-client-cli]: https://github.com/plurid/delog/tree/master/packages/delog-client/delog-cli
        
        
        <a target="_blank" href="https://www.npmjs.com/package/@plurid/delog">
            <img src="https://img.shields.io/npm/v/@plurid/delog.svg?logo=npm&colorB=1380C3&style=for-the-badge" alt="Version">
        </a>
        
        [@plurid/delog-client-javascript][delog-client-javascript] • the `NodeJS` client
        
        [delog-client-javascript]: https://github.com/plurid/delog/tree/master/packages/delog-client/delog-javascript
        
        
        <a target="_blank" href="https://pypi.org/project/delog">
            <img src="https://img.shields.io/pypi/v/delog.svg?logo=pypi&colorB=1380C3&style=for-the-badge" alt="Version">
        </a>
        
        [@plurid/delog-client-python][delog-client-python] • the `Python` client
        
        [delog-client-python]: https://github.com/plurid/delog/tree/master/packages/delog-client/delog-python
        
        
        
        ## [Codeophon](https://github.com/ly3xqhl8g9/codeophon)
        
        + licensing: [delicense](https://github.com/ly3xqhl8g9/delicense)
        + versioning: [αver](https://github.com/ly3xqhl8g9/alpha-versioning)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
