Nature Preceded Machines

    @ngworker/lumberjack-firestore-driver
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published

    @ngworker/lumberjack-firestore-driver

    Logo by Felipe Zambrano


    MIT commitizen PRs styled with prettier All Contributors ngworker spectator Wallaby.js

    Lumberjack Firestore Driver is a custom log driver for ngworker/lumberjack. It is used to send logs and store them in Cloud Firestore.

    Features

    • Logs to Cloud Firestore
    • Unit test coverage (but there is a room for improvement)
    • Custom Logger
    • Follows Lumberjack Best Practices guide

    Table of Contents

    Installation

    LumberjackFirestoreDriver is published as the @ngworker/lumberjack-firestore-driver package.

    Toolchain Command
    Angular CLI ng add @ngworker/lumberjack-firestore-driver
    NPM CLI npm install @ngworker/lumberjack-firestore-driver
    Yarn CLI yarn add @ngworker/lumberjack-firestore-driver

    Compatibility

    LumberjackFirestoreDriver has verified compatibility with the following Angular versions.

    Angular version lumberjack-firestore-driver support
    11.0.x
    10.2.x
    10.1.x
    10.0.x
    9.1.x
    9.0.x

    If the version you are using is not listed, please raise an issue in our GitHub repository.

    Usage

    TODO: Verify that these configurations match your driver configurations.

    To start using LumberjackFirestoreDriver, import it in your root or core Angular module along with Lumberjack.

    import { NgModule } from '@angular/core';
    import { LumberjackLevel, LumberjackModule } from '@ngworker/lumberjack';
    import { LumberjackFirestoreDriver } from '@ngworker/lumberjack-firestore-driver';
    
    @NgModule({
      imports: [
        LumberjackModule.forRoot({
          levels: [LumberjackLevel.Verbose],
        }),
        LumberjackFirestoreDriver.forRoot({
          levels: [LumberjackLevel.Critical, LumberjackLevel.Error],
          firebaseConfig: {
            apiKey: 'API_KEY',
            authDomain: 'PROJECT_ID.firebaseapp.com',
            databaseURL: 'https://PROJECT_ID.firebaseio.com',
            projectId: 'PROJECT_ID',
            storageBucket: 'PROJECT_ID.appspot.com',
            messagingSenderId: 'SENDER_ID',
            appId: 'APP_ID',
            measurementId: 'G-MEASUREMENT_ID',
          },
          origin: 'YOUR_ORIGIN_APP_NAME',
          collectionName: 'DESTINATION_FIRESTORE_COLLECTION_NAME',
        }),
        // (...)
      ],
      // (...)
    })
    export class AppModule {}

    Now you can start using the LumberjackService or extend LumberjackLogger and they will automatically use the LumberjackFirestoreDriver.

    Configuration

    You should follow the standard Cloud Firestore configuration way which is well described in official documentation Cloud Firestore docs

    Wallaby.js

    Wallaby.js

    Contributors to this repository are welcome to use the Wallaby.js OSS License to get test results immediately as you type, and see the results in your editor right next to your code.

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Marcin Milewicz

    💻📖

    Lars Gyrup Brink Nielsen

    💻📖

    Nacho Vazquez

    💻📖

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i @ngworker/lumberjack-firestore-driver

    DownloadsWeekly Downloads

    3

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    145 kB

    Total Files

    27

    Last publish

    Collaborators

    • marcinmilewicz