cookbook 'netuitive', '= 0.22.1'
netuitive (14) Versions 0.22.1 Follow0
Installs/Configures netuitive/metricly
cookbook 'netuitive', '= 0.22.1', :supermarket
knife supermarket install netuitive
knife supermarket download netuitive
Netuitive Cookbook (Chef)
A cookbook to automate the installation and configuration of the Netuitive Linux agent. For more
information on the Netuitive Linux Agent, see the help docs or contact Netuitive support at support@netuitive.com.
This cookbook is meant to be consumed by wrapper cookbooks such as this: wrapper cookbook
Attributes
Key | Type | Description | Default |
---|---|---|---|
node['netuitive']['version'] |
String | The version of the agent to install | '0.2.9-98' |
node['netuitive']['repo']['urls'] |
Hash | A hash of platform specific repo urls | { 'debian' => 'https://repos.app.netuitive.com/deb/', 'rhel' => 'https://repos.app.netuitive.com/rpm/noarch' } |
node['netuitive']['repo']['keys'] |
Hash | A hash of platform specific repo gpg key locations | { 'debian' => 'https://repos.app.netuitive.com/netuitive.gpg', 'rhel' => 'https://repos.app.netuitive.com/RPM-GPG-KEY-netuitive' } |
node['netuitive']['repo']['components'] |
Hash | A hash of platform specific compnents | { 'debian' => ['stable', 'main'] } |
node['netuitive']['custom_collectors'] |
Hash | A hash of collectors and options | {} |
Supported Platforms
Operating Systems
Official
Supported and tested locally with vagrant:
- Ubuntu 16.04 LTS
- Ubuntu 14.04 LTS
- CentOS 6.7+
- Centos 7.2+
- Debian 8
Tested platforms by travisci:
- centos 6
- centos 7
Unofficial
We will attempt to support as many linux distributions as possible and are hoping to expand the above list over time. Any EPEL based system that still supports yum will likely work and we are open to PRs to expands functionality.
Chef Versions
Chef 12.x
We support all versions of 12.x (even if we don't test it regularly).
Chef 11.x
We have written this cookbook using many of the nicer things of chef 12. We are open to community contributions to enable/improve the cookbook to support older versions of chef within reason. If you need chef 11 support in the mean time please see the feature/chef-11-compatibility
branch.
Using the Netuitive Cookbook
Recipes
All recipes are simple wrappers around the lightweight resources and providers (LWRPs). We suggest using LWRPs over recipes as it will provide flexibility.
Name | Description |
---|---|
netuitive::default | Does nothing. |
netuitive::add_repo | Adds the Netuitive repo. |
netuitive::configure | Sets base and custom config. |
netuitive::install_agent | Installs the agent. |
LWRPs
netuitive_configure
Actions
:create
Attributes
Name | Description | Default |
---|---|---|
api_key | Your datasource's API key. | 'CHANGE_ME_PLZ' |
api_url | The API url for netuitive. | 'https://api.app.netuitive.com/ingest/infrastructure' |
batch_size | Number of samples to store before sending to Metricly | 500 |
conf_path | The path to your Netuitive agent config file. | '/opt/netuitive-agent/conf/netuitive-agent.conf' |
cookbook_template | Specifies a different cookbook that the template can come from. | 'netuitive' |
disk_space_collector_exclude_filters | Specifies an exclude filter for metrics | ^/boot, ^/mnt |
disk_usage_collector_metrics_whitelist | Specifies the metrics whitelist for the DiskUsageCollector. You might change this if you wanted to ignore the Docker device mapper metrics. | `'(?:.*.io$ |
docker_collector_enabled | Whether or not to enable the Docker collector. May be true or false . |
false |
docker_collector_metrics_whitelist | Specifies the metrics whitelist for the NetuitiveDockerCollector. | .* |
relations | An array of relations. | [] |
source | The name of the template. | 'netuitive-agent.conf.erb' |
statsd_enabled | Whether to enable embedded statsd server. Specify the string 'True' or 'False'
|
'False' |
statsd_forward | Whether or not to forward stats from the embedded statsd server. May be true or false
|
false |
statsd_forward_ip | The IP to forward statsd data to if forwarding is enabled. | '127.0.0.1' |
statsd_forward_port | The port to forward statsd data to if forwarding is enabled. | 9125 |
statsd_listen_ip | The interface to listen on if statsd is enabled. | '127.0.0.1' |
statsd_listen_port | The port the embedded statsd listens on | 8125 |
statsd_prefix | Prefix applied to your statsd metrics | statsd |
tags | An array of tags . | [] |
netuitive_collector
Actions
:create
Attributes
Name | Description | Default |
---|---|---|
conf_path | The path to your Netuitive agent config file. | '/opt/netuitive-agent/conf/netuitive-agent.conf' |
cookbook_template | Specifies a different cookbook that the template can come from. | 'netuitive' |
collectors_dir | Dir that custom collectors live in. | '/opt/netuitive-agent/conf/collectors' |
custom_collectors | A hash of collectors and options to create. | {} |
source | The name of the template. | 'collector_generic.conf.erb' |
netuitive_install
Actions
:install
Attributes
Name | Description | Default |
---|---|---|
package_name | The package's name. | 'netuitive-agent' |
netuitive_repo
Actions
:add
Attributes
Name | Description | Default |
---|---|---|
repo_components | A hash of platform-specific components. | nil |
repo_keys | A hash of platform-specific repository GPG keys. | nil |
repo_priority_pins | A hash of platform-specific repo pins. | nil |
repo_urls | A hash of platform-specific repository URLs. | nil |
use_epel_repos | Bool value to enable EPEL repos (doesn't do anything on Debian-based repos). | nil |
version | The version to pin. | nil |
Additional Information
License and Authors
This software is licensed under MIT license quoted below:
The MIT License (MIT)
Copyright (c) 2016 Ben Abrams
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Dependent cookbooks
apt >= 0.0.0 |
yum >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Change Log
This project adheres to Semantic Versioning.
[Unreleased]
0.22.1
- fix/define
docker_collector_metrics_whitelist
option
0.22.0
- added
docker_collector_metrics_whitelist
0.21.0.2-0.21.6
- no-op testing travis supermarket deploys
0.21.1
- properly reflected in metadata the reality regarding licensing and chef_version support (@majormoses)
0.21.0
- added
batch_size
@johvet
0.20.0
- added
disk_space_collector_exclude_filters
@johvet
0.19.0
- added
statsd_prefix
option tonetuitive_configure
0.18.0
- added travis deploys to supermarket @TheConnMan
0.17.1
- changed to use chef-client 12.16
- fixed issue with apt repository creation per #49. @Createor
0.17.0
- bump default collector agent version @Createor
0.16.0
- added support for Ubuntu 16.04 LTS and made it an an officially supported platforms
- updating gem dependencies
- removed ruby 2.1 support
- removed chef 11 testing as its support exists in its own branch and I would not expect any more work done on it.
- setup travis to run kitchen tests for centos-6 and centos-7 (more to come later)
0.15.1
- fixes template issues when using statsd that were caused in #46. @ziggythehamster
0.15.0
- added
statsd_forward
,statsd_forward_ip
,statsd_forward_port
,statsd_listen_ip
, andstatsd_listen_port
options tonetuitive_configure
@ziggythehamster
0.14.0
- added
disk_usage_collector_metrics_whitelist
@ziggythehamster - improved README.md @ziggythehamster
0.13.0
- fix typos in tags and relations @ziggythehamster
- fix typo with logger repo provider @ziggythehamster
- added
docker_collector_enabled
@ziggythehamster
0.12.0
- adding some tools for making versioning and tagging easier
- adding doc on chef version compatibility
- restructure testing to allow multiple versions to be developed and tested
0.11.0 (cheff 11 branch)
- adding some tools to make versioning easier
- adding doc on chef version compatibility
- chef 11 support (not compatible with 12 so its in its own branch)
- restructure testing to allow multiple versions to be developed and tested
0.10.0
- make sure that agent restarts when custom collector config changes (is added).
0.9.0
- Update to latest Netuitive-agent (0.2.9-98)
0.8.0
- cleanup deprecated code
0.7.0
- Update to latest Netuitive-agent (0.2.8-97)
0.6.0
- Update to latest Netuitive-agent (0.2.7-96)
0.4.0
- Update to latest Netuitive-agent (0.2.6-95)
- Update default netuitive-agent.conf template
0.3.1
Fixed
- bad metadata for platforms supported
0.3.0
Added
- Support for epel based systems
0.2.0
Added
- foodcritic testing ### Changed
- All LWRPs use
use_inline_resources
to address foodcritic ~FC057
0.1.1
- Update to latest Netuitive-agent (0.2.3-70)
0.1.0
- Initial release of netuitive
Collaborator Number Metric
0.22.1 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.22.1 passed this metric
Foodcritic Metric
0.22.1 passed this metric
No Binaries Metric
0.22.1 passed this metric
Testing File Metric
0.22.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.22.1 passed this metric
0.22.1 failed this metric
0.22.1 passed this metric
Foodcritic Metric
0.22.1 passed this metric
No Binaries Metric
0.22.1 passed this metric
Testing File Metric
0.22.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.22.1 passed this metric
0.22.1 passed this metric
0.22.1 passed this metric
Testing File Metric
0.22.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.22.1 passed this metric
0.22.1 failed this metric
0.22.1 passed this metric