Colotok Docs Help

Plugin

Plugins are a powerful way to extend Colotok's functionality beyond its core features. This page explains what plugins are, how they work, and how they can enhance your logging experience.

What are Colotok Plugins?

In Colotok, plugins are extensions that add new capabilities to the logging system. They can:

  • Add support for new logging destinations (like cloud services or databases)

  • Provide integration with other libraries and frameworks

  • Add new formatting options

  • Enhance existing functionality with additional features

Plugins follow a consistent architecture that makes them easy to use and integrate with your application.

Plugin Architecture

Colotok has a flexible plugin architecture based on interfaces that define the contract between the core library and plugins:

  • Provider Interface: The foundation of the plugin system, defining methods for writing logs to various destinations

  • ProviderConfig Interface: Defines configuration options for providers

  • AsyncProvider Interface: Extends the Provider interface to add support for asynchronous logging

This architecture allows plugins to be:

  • Modular: Each plugin focuses on a specific functionality

  • Configurable: Plugins can be customized to meet your specific needs

  • Composable: Multiple plugins can be used together in the same application

Benefits of Using Plugins

Using Colotok plugins offers several advantages:

  1. Extended Functionality: Access features beyond the core library

  2. Simplified Integration: Easily connect with other systems and services

  3. Consistent API: Use the same logging API regardless of the destination

  4. Platform Flexibility: Some plugins support multiple platforms (JVM, JS, Native)

  5. Customization: Adapt logging behavior to your specific requirements

Types of Plugins

Colotok plugins generally fall into these categories:

1. Integration Plugins

These plugins connect Colotok with external systems:

  • colotok-cloudwatch: Sends logs to AWS CloudWatch

  • colotok-loki: Sends logs to Grafana Loki

  • colotok-slf4j: Allows Colotok to be used as an SLF4J implementation

2. Enhancement Plugins

These plugins add new capabilities to Colotok:

  • colotok-coroutines: Adds coroutine support for asynchronous logging

3. Custom Plugins

You can also create your own plugins to:

  • Send logs to custom destinations

  • Implement specialized formatting

  • Add domain-specific logging features

Getting Started with Plugins

To use a plugin, you need to:

  1. Add the plugin dependency to your project

  2. Configure the plugin according to your needs

  3. Add the plugin's provider to your logger configuration

For example, to use the colotok-coroutines plugin:

// Add dependency implementation("io.github.milkcocoa0902:colotok-coroutines:0.3.3") // Use the plugin runBlocking { logger.infoAsync("Async log message") }

Learn More

For more information about Colotok plugins, check these resources:

Last modified: 07 July 2025
Custom FormatterOfficial Plugin