Project

fluent-plugin-calyptia-monitoring

0.0
Repository is archived
No release in over 3 years
Low commit activity in last 3 years
fluent-plugin-calyptia-monitoringcalyptia/fluent-plugin-calyptia-monitoringHomepageDocumentationSource CodeBug TrackerWiki
Monitoring Fluentd via Calyptia Cloud
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
73,598
Stars
0
Forks
1
Watchers
3
 Releases
Current version
0.1.3
Total releases
13
First release
2021-07-21
Latest release
2021-10-05
 Issues
Open Issues
1
Closed Issues
2
Total Issues
3
Issue Closure Rate
66%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
9
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
Apache-2.0
Average date of last 50 commits
2021-09-09
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 2.2.15
rake
~> 13.0
test-unit
~> 3.3

Runtime

fluentd
>= 1.14.0, < 2
fluent-plugin-metrics-cmetrics
>= 0.1.1
 Project Readme

fluent-plugin-calyptia-monitoring

Fluentd input plugin to ingest metrics into Calyptia Cloud.

Installation

RubyGems

$ gem install fluent-plugin-calyptia-monitoring

Bundler

Add following line to your Gemfile:

gem "fluent-plugin-calyptia-monitoring"

And then execute:

$ bundle

Plugin helpers

Fluent::Plugin::CalyptiaMonitoringInput

<cloud_monitoring> section (required) (single)

Configuration

parameter type description default
endpoint string (optional) The endpoint for Monitoring API HTTP request, e.g. http://example.com/api "https://cloud-api.calyptia.com"
api_key string (required) The API KEY for Monitoring API HTTP request
rate time (optional) Emit monitoring values interval. (minimum interval is 30 seconds.) 30
pending_metrics_size size (optional) Setup pending metrics capacity size 100
fluentd_conf_path string (optional) Specify Fluentd config file path for RPC not to be available case nil

Example

This plugin works well with cmetrics Fluentd extension for metrics plugin.

And enabling RPC and configDump endpoint is required if sending Fluentd configuration:

<system>
# If users want to use multi workers feature which corresponds to logical number of CPUs, please comment out this line.
#  workers "#{require 'etc'; Etc.nprocessors}"
  enable_input_metrics true
  # This record size measuring settings might impact for performance.
  # Please be careful for high loaded environment to turn on.
  enable_size_metrics true
  <metrics>
    @type cmetrics
  </metrics>
  rpc_endpoint 127.0.0.1:24444
  enable_get_dump true
</system>
# And other configurations....

## Fill YOUR_API_KEY with your Calyptia API KEY
<source>
  @type calyptia_monitoring
  @id input_caplyptia_moniroting
  <cloud_monitoring>
    # endpoint http://development-environment-or-production.fqdn:5000
    api_key YOUR_API_KEY
    rate 30
    pending_metrics_size 100 # Specify capacity for pending metrics
  </cloud_monitoring>
  <storage>
    @type local
    path /path/to/agent/accessible/directories/agent_states
  </storage>
</source>

And also retrieving configuration from actual file is also supported:

<system>
# If users want to use multi workers feature which corresponds to logical number of CPUs, please comment out this line.
#  workers "#{require 'etc'; Etc.nprocessors}"
  enable_input_metrics true
  # This record size measuring settings might impact for performance.
  # Please be careful for high loaded environment to turn on.
  enable_size_metrics true
  <metrics>
    @type cmetrics
  </metrics>
</system>
# And other configurations....

## Fill YOUR_API_KEY with your Calyptia API KEY
<source>
  @type calyptia_monitoring
  @id input_caplyptia_moniroting
  <cloud_monitoring>
    # endpoint http://development-environment-or-production.fqdn:5000
    api_key YOUR_API_KEY
    rate 30
    pending_metrics_size 100 # Specify capacity for pending metrics
    fluentd_conf_path /path/to/fluent.conf
  </cloud_monitoring>
  <storage>
    @type local
    path /path/to/agent/accessible/directories/agent_states
  </storage>
</source>

Note: We recommend to use RPC version due to some circumstances should differ between a loaded configuration and a saved Fluentd configuration. This is because calling dumping config RPC feature can obtain from configuration contents which are loaded on memory. But retrieving configuration from the specified file is just read from the file contents and it cannot handle/retrieve loaded configurations on Fluentd. When users just update their Fluentd configurations and forgot to restart/reload their Fluentd instances, loaded configurations differ from just edited ones.

Calyptia Monitoring API config generator

Usage:

Usage: calyptia-config-generator api_key [options]

Generate Calyptia monitoring plugin config definitions

Arguments:
	api_key: Specify your API_KEY

Options:
        --endpoint URL               API Endpoint URL (default: nil, and if omitted, using default endpoint)
        --rpc-endpoint URL           Specify RPC Endpoint URL (default: 127.0.0.1:24444)
        --disable-input-metrics      Disable Input plugin metrics. Input metrics is enabled by default
        --enable-size-metrics        Enable event size metrics. Size metrics is disabled by default.
        --disable-get-dump           Disable RPC getDump procedure. getDump is enabled by default.
        --storage-agent-token-dir DIR
                                     Specify accesible storage token dir. (default: /path/to/accesible/dir)
        --fluentd-conf-path PATH     Specify fluentd configuration file path. (default: nil)

Copyright

  • Copyright(c) 2021- Calyptia Inc.
  • Maintainer: Hiroshi Hatake hatake@calyptia.com
  • License
    • Apache License, Version 2.0