@calyptia/fluent-bit-config-parser

Configuration parser for Fluent-bit

Table of Contents

• Getting Started
  • How to import
  • Use Cases
• Contributing
• License

Getting Started

fluent-bit configuration parser will allow you to validate some aspects of fluent-bit configuration.

for more information about fluent-bit configuration you can visit fluent-bit website.

How to import

You can import the parser as follows:

import { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';

This library offers a couple of methods:

schema: it will return the parsed configuration as a fluent-bit schema.

toString(): it will return the parsed schema, back to a string

source: it will return the config as it was provided.

FluentBitSchema.isFluentBitConfiguration: A static method, to validate if the configuration is fluentBit. It's important to notice, that this method, will not confirm if the provided config is valid. For that please see below:

Use cases.

I have a file, but I'm not sure if is fluent-bit or Fluentd:

import fs from 'fs';

import { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';

const file = fs.readFileSync('/path/to/file.conf', { encoding: 'utf-8' });

console.log(FluentBitSchema.isFluentBitConfiguration(file)); // => true/false

I want to confirm if my fluent-bit configuration is valid:

import fs from 'fs';

import { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';

const file = fs.readFileSync('/path/to/file.conf', { encoding: 'utf-8' });

try {
  const config = new FluentBitSchema(file);
  console.log('yay! my configuration is valid');
} catch (e) {
  console.log(e.message); // this message will provide some insight int what went wrong.
}

I would like to re-format my configuration.

import fs from 'fs';

import { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';

const file = fs.readFileSync('/path/to/file.conf', { encoding: 'utf-8' });

const config = new FluentBitSchema(file);

console.log(config.toString());

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated greatly appreciated.

• Fork the Project
• Create your Feature Branch (git checkout -b feature/AmazingFeature)
• Commit your Changes (git commit -m 'Add some AmazingFeature')
• Push to the Branch (git push origin feature/AmazingFeature)
• Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Changelog

v1.1.2

10 February 2022

• we should export the TokenError class as a First Citizen #27
• 1.1.1 #26