fluent-plugin-calyptia-monitoring 0.1.0.rc → 0.1.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: efc4e7d0b11c4581475feb8c18c52a7e4366d8ada239ae16db853dc36eb886fd
4
- data.tar.gz: 5db76c13993681bab21c389ce6d5edf2c78e03b64540a409d4bc2791e26e6b29
3
+ metadata.gz: e354b4af025ab4d6212f2cc59fd2c356e97d7900fc873cf56798107ce9545dbb
4
+ data.tar.gz: 4ebb6949a092949b0c2cd8e21d2636a56c2e969f209a89555bddb3467c2a528e
5
5
  SHA512:
6
- metadata.gz: e74b8aecb6b7b83dafcb999daabe7ebd64d607fb9352ca3dfa14161d612c2bf12a9c3fd6125979203d928f4b1d46676084f49c6299ce68e21f4f92fa2a73647f
7
- data.tar.gz: 60137eaa0870327d7eb1c2485b04c0583558b375af3243ce3c11c94b6c70255d31cad86009d23e547f50dd578fd93b313a930575377c14b1cfdfcfeb01817c3f
6
+ metadata.gz: 897bef9550f355493d137d799d21f1c202a60d026299117b931bb6dadee00a219faaa08fe1f2a47f6180afe5037fece2948f4fa37766b7efa1288f1fb0f2bdc9
7
+ data.tar.gz: 5b21d181a087e333acb4468fed8c3d7ee7e5843a9e1e635c499bec31c8e46c27d3f4b1c87ab6a41fa2c6c43f4d849373f7dd565afb3e14568c99a0fcac879030
data/README.md CHANGED
@@ -1,8 +1,6 @@
1
1
  # fluent-plugin-calyptia-monitoring
2
2
 
3
- [Fluentd](https://fluentd.org/) input plugin to do something.
4
-
5
- TODO: write description for you plugin.
3
+ [Fluentd](https://fluentd.org/) input plugin to ingest metrics into Calyptia Cloud.
6
4
 
7
5
  ## Installation
8
6
 
@@ -26,15 +24,62 @@ And then execute:
26
24
  $ bundle
27
25
  ```
28
26
 
29
- ## Configuration
30
-
31
- You can generate configuration template:
32
-
27
+ ## Plugin helpers
28
+
29
+ * [timer](https://docs.fluentd.org/v/1.0/plugin-helper-overview/api-plugin-helper-timer)
30
+ * [storage](https://docs.fluentd.org/v/1.0/plugin-helper-overview/api-plugin-helper-storage)
31
+
32
+ * See also: [Input Plugin Overview](https://docs.fluentd.org/v/1.0/input#overview)
33
+
34
+ ## Fluent::Plugin::CalyptiaMonitoringInput
35
+
36
+
37
+ ### \<cloud_monitoring\> section (required) (single)
38
+
39
+ ### Configuration
40
+
41
+ |parameter|type|description|default|
42
+ |---|---|---|---|
43
+ |endpoint|string (optional)|The endpoint for Monitoring API HTTP request, e.g. http://example.com/api|`TBD`|
44
+ |api_key|string (required)|The API KEY for Monitoring API HTTP request||
45
+ |rate|time (optional)|Emit monitoring values interval. (minimum interval is 30 seconds.)|`30`|
46
+ |pending_metrics_size|size (optional)|Setup pending metrics capacity size|`100`|
47
+
48
+ ### Example
49
+
50
+ This plugin works well with [cmetrics Fluentd extension for metrics plugin](https://github.com/calyptia/fluent-plugin-metrics-cmetrics).
51
+
52
+ And enabling RPC and configDump endpoint is requireed if sending Fluentd configuration:
53
+
54
+ ```aconf
55
+ <system>
56
+ # If users want to use multi workers feature which corresponds to logical number of CPUs, please comment out this line.
57
+ # workers "#{require 'etc'; Etc.nprocessors}"
58
+ enable_input_metrics true
59
+ <metrics>
60
+ @type cmetrics
61
+ </metrics>
62
+ rpc_endpoint 127.0.0.1:24444
63
+ enable_get_dump true
64
+ </system>
65
+ # And other configurations....
66
+
67
+ ## Fill YOUR_API_KEY with your Calyptia API KEY
68
+ <source>
69
+ @type calyptia_monitoring
70
+ @id input_caplyptia_moniroting
71
+ <cloud_monitoring>
72
+ # endpoint http://development-environment-or-production.fqdn:5000
73
+ api_key YOUR_API_KEY
74
+ rate 30
75
+ pending_metrics_size 100 # Specify capacity for pending metrics
76
+ </cloud_monitoring>
77
+ <storage>
78
+ @type local
79
+ path /path/to/agent/accessible/directories/agent_states
80
+ </storage>
81
+ </source>
33
82
  ```
34
- $ fluent-plugin-config-format input calyptia-monitoring
35
- ```
36
-
37
- You can copy and paste generated documents here.
38
83
 
39
84
  ## Copyright
40
85
 
@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
3
 
4
4
  Gem::Specification.new do |spec|
5
5
  spec.name = "fluent-plugin-calyptia-monitoring"
6
- spec.version = "0.1.0.rc"
6
+ spec.version = "0.1.0.rc2"
7
7
  spec.authors = ["Hiroshi Hatake"]
8
8
  spec.email = ["hatake@calyptia.com"]
9
9
 
@@ -43,7 +43,7 @@ module Fluent
43
43
  400, # BadRequest
44
44
  ]
45
45
 
46
- config_section :cloud_monitoring, multi: false do
46
+ config_section :cloud_monitoring, multi: false, required: true do
47
47
  desc 'The endpoint for Monitoring API HTTP request, e.g. http://example.com/api'
48
48
  config_param :endpoint, :string, default: "https://cloud-monitoring-api-dev.fluentbit.io"
49
49
  desc 'The API KEY for Monitoring API HTTP request'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fluent-plugin-calyptia-monitoring
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.rc
4
+ version: 0.1.0.rc2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Hiroshi Hatake