<commit_before>Boundary Varnish Cache Plugin
=============================

The Boundary Varnish Cache plugin collects information on Varnish Cache.

### Prerequisites

#### Supported OS

|     OS    | Linux | Windows | SmartOS | OS X |
|:----------|:-----:|:-------:|:-------:|:----:|
| Supported |   v   |    v    |    v    |  v   |

#### For Boundary Meter versions v4.2 or greater

- To install new meter go to Settings->Installation or [see instructons](https://help.boundary.com/hc/en-us/sections/200634331-Installation). 
- To upgrade the meter to the latest version - [see instructons](https://help.boundary.com/hc/en-us/articles/201573102-Upgrading-the-Boundary-Meter). 

#### For Boundary Meter less than v4.2

|  Runtime | node.js | Python | Java |
|:---------|:-------:|:------:|:----:|
| Required |         |   v    |      |

The plugin requires Python 2.6 or later.

### Plugin Setup

The plugin requires the [varnishstat](https://www.varnish-cache.org/docs/4.0/reference/varnishstat.html#ref-varnishstat) command to be available and in the system path.

### Plugin Configuration Fields

The plugin will, by default, collect metrics from the Varnish instance named after the hostname of the machine it is running on.  You can collect metrics on different instances by configuring one or more instance names.

General operations for plugins are described in [this article](http://premium-support.boundary.com/customer/portal/articles/1635550-plugins---how-to).

#### For Boundary Meter v4.2

|Field Name     |Description                                                 |
|:--------------|:-----------------------------------------------------------|
|Source         |The source to display in the legend for the default intance.|
|PollInterval   |Interval to query the varnishstat                           |
|Items          |Array of instances                                          |<commit_msg>Fixed typos and formatting in README<commit_after># Boundary Varnish Cache Plugin

The Boundary Varnish Cache plugin collects information on Varnish Cache.

### Prerequisites

#### Supported OS

|     OS    | Linux | Windows | SmartOS | OS X |
|:----------|:-----:|:-------:|:-------:|:----:|
| Supported |   v   |    v    |    v    |  v   |

#### For Boundary Meter versions v4.2 or later 

- To install new meter go to Settings->Installation or [see instructions](https://help.boundary.com/hc/en-us/sections/200634331-Installation). 
- To upgrade the meter to the latest version - [see instructions](https://help.boundary.com/hc/en-us/articles/201573102-Upgrading-the-Boundary-Meter). 

#### For Boundary Meter earlier than v4.2

|  Runtime | node.js | Python | Java |
|:---------|:-------:|:------:|:----:|
| Required |         |   v    |      |

The plugin requires Python 2.6 or later.

### Plugin Setup

The plugin requires the [varnishstat](https://www.varnish-cache.org/docs/4.0/reference/varnishstat.html#ref-varnishstat) command to be available and in the system path.

### Plugin Configuration Fields

The plugin will, by default, collect metrics from the Varnish instance named after the hostname of the machine it is running on.  You can collect metrics on different instances by configuring one or more instance names.

General operations for plugins are described in [this article](http://premium-support.boundary.com/customer/portal/articles/1635550-plugins---how-to).

#### For Boundary Meter v4.2

|Field Name     |Description                                                 |
|:--------------|:-----------------------------------------------------------|
|Source         |The source to display in the legend for the default intance.|
|PollInterval   |Interval to query the varnishstat                           |
|Items          |Array of instances                                          |
{'fraction_non_alphanumeric': 0.17377649829887465, 'fraction_numerical': 0.018319811567652448, 'mean_word_length': 2.135356849876948, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5460581', 'n_tokens_mistral': 1086, 'n_tokens_neox': 1011, 'n_words': 340}