<commit_before>Bleemeo-cookbook
===

About
---

Bleemeo is a Cloud based monitoring solution. This cookbook deploys the agent
on servers you want to monitor. Free trial is available at https://bleemeo.com/trial

This cookboot is a community contribution and is not officially supported.


Install Bleemeo agent using repositories.
---

### Supported Platforms

- Ubuntu 16.04
- Debian 8
- Centos 7.3
- Fedora 24

### Attributes

#### account (uuid v4)

`node['bleemeo']['account']`

ID of the account to connect node to.

#### key (uuid v4)

`node['bleemeo']['key']`

Registration key to allow node to register.

#### auto-upgrade (boolean)

`node['bleemeo']['auto-upgrade']`

Define version strategy, will upgrade automatically if true or stick to the same
version.

> default to false

#### tags (Array)

`node['bleemeo']['tags']`

List of tags for the agent. Your agent will be tagged with those tags on Bleemeo Cloud Platform.

Only create associated configuration file if `bleemeo::configure` is ran.

> default to ['chef-client']

### Usage

Include `bleemeo` in your node's `run_list`:

```json
{
  "run_list": [
    "recipe[bleemeo::default]"
  ],
  "normal": {
    "bleemeo": {
      "account": "YOUR_ACCOUNT_ID",
      "key": "YOUR_REGISTRATION_KEY"
    }
  },
}
```

### Recipes

#### bleemeo::default / bleemeo::install

Install and configure Bleemeo agent from repositories

#### bleemeo::repositories

Install Bleemeo agent's repositories, included in `bleemeo::install`.

#### bleemeo::configure

Create default Bleemeo agent's configuration folder and files, included in `bleemeo::install`.

### Resources

#### bleemeo_tcp_check

Define a tcp custom check

```ruby
bleemeo_tcp_check 'name' do
  id              String  # defaults to 'name' if not specified
  port            Integer # required
  address         String  # default to 127.0.0.1
end
```

#### bleemeo_http_check

Define a http(s) custom check

```ruby
bleemeo_http_check 'name' do
  id              String  # defaults to 'name' if not specified
  tls             TrueClass, FalseClass # default to false
  port            Integer # required
  address         String  # default to 127.0.0.1
  path            String  # default to /
  status_code     Integer
end
```

#### bleemeo_nagios_check

Define a nagios custom check

```ruby
bleemeo_nagios_check 'name' do
  id              String  # defaults to 'name' if not specified
  command         String  # required
end
```


### Tests

**Require vagrant and virtualbox.**

Install gems (bershshelf, test-kitchen, kitchen-vagrant) : `bundler install`

Run tests : `kitchen test`

### License (MIT)

Copyright 2017 Matlo

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.<commit_msg>Some doc about resources<commit_after>Bleemeo-cookbook
===

About
---

Bleemeo is a Cloud based monitoring solution. This cookbook deploys the agent
on servers you want to monitor. Free trial is available at https://bleemeo.com/trial

This cookboot is a community contribution and is not officially supported.


Install Bleemeo agent using repositories.
---

### Supported Platforms

- Ubuntu 16.04
- Debian 8
- Centos 7.3
- Fedora 24

### Attributes

#### account (uuid v4)

`node['bleemeo']['account']`

ID of the account to connect node to.

#### key (uuid v4)

`node['bleemeo']['key']`

Registration key to allow node to register.

#### auto-upgrade (boolean)

`node['bleemeo']['auto-upgrade']`

Define version strategy, will upgrade automatically if true or stick to the same
version.

> default to false

#### tags (Array)

`node['bleemeo']['tags']`

List of tags for the agent. Your agent will be tagged with those tags on Bleemeo Cloud Platform.

Only create associated configuration file if `bleemeo::configure` is ran.

> default to ['chef-client']

### Usage

Include `bleemeo` in your node's `run_list`:

```json
{
  "run_list": [
    "recipe[bleemeo::default]"
  ],
  "normal": {
    "bleemeo": {
      "account": "YOUR_ACCOUNT_ID",
      "key": "YOUR_REGISTRATION_KEY"
    }
  },
}
```

### Recipes

#### bleemeo::default / bleemeo::install

Install and configure Bleemeo agent from repositories

#### bleemeo::repositories

Install Bleemeo agent's repositories, included in `bleemeo::install`.

#### bleemeo::configure

Create default Bleemeo agent's configuration folder and files, included in `bleemeo::install`.

### Resources

#### bleemeo_tcp_check

Define a tcp custom check

```ruby
bleemeo_tcp_check 'name' do
  id              String  # defaults to 'name' if not specified
  port            Integer # required
  address         String  # default to 127.0.0.1
end
```

#### bleemeo_http_check

Define a http(s) custom check

```ruby
bleemeo_http_check 'name' do
  id              String  # defaults to 'name' if not specified
  tls             TrueClass, FalseClass # default to false
  port            Integer # required
  address         String  # default to 127.0.0.1
  path            String  # default to /
  status_code     Integer
end
```

#### bleemeo_nagios_check

Define a nagios custom check

```ruby
bleemeo_nagios_check 'name' do
  id              String  # defaults to 'name' if not specified
  command         String  # required
end
```

#### bleemeo_pull_metric

Define a custom poll metric.

```ruby
bleemeo_pull_metric 'name' do
  id              String  # default to 'name' if not specified
  url             String  # required
  item            [String, nil]
  ssl_check       [TrueClass, FalseClass]  # default to true
  username        [String, nil]
  password        [String, nil]
end
```

#### bleemeo_prometheus_endpoint

Define a custom prometheus endpoint.

```ruby
bleemeo_prometheus_endpoint 'name' do
  id              String  # default to 'name' if not specified
  url             String  # required
end
```

### Tests

**Require vagrant and virtualbox.**

Install gems (bershshelf, test-kitchen, kitchen-vagrant) : `bundler install`

Run tests : `kitchen test`

### License (MIT)

Copyright 2017 Matlo

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.
{'fraction_non_alphanumeric': 0.09674669697400198, 'fraction_numerical': 0.007671544253445092, 'mean_word_length': 3.498402555910543, 'pattern_counts': {'":': 10, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 4, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1131719', 'n_tokens_mistral': 2178, 'n_tokens_neox': 2028, 'n_words': 803}