# fluent-plugin-jfrog-send-metrics

[Fluentd](https://fluentd.org/) output plugin to consume metrics emitted from [fluent-plugin-jfrog-metrics](https://github.com/jfrog/jfrog-fluentd-plugins/tree/main/fluent-plugin-jfrog-metrics) input plugin and send them to respective log-vendors.

## Building

To build / test locally use rake:

```text
rake
```

To build install locally use bundler:

```text
bundle install
```

This will install the gem shown below from source.

## Development

### Bundler

Add following line to your Gemfile:

```ruby
gem "fluent-plugin-jfrog-send-metrics"
```

And then execute:

```
$ bundle
```

## Configuration

You can generate configuration template:

```
$ fluent-plugin-config-format output jfrog-send-metrics
```

You can copy and paste generated documents here.

## Installation

### RubyGems

```
$ gem install rest-client
$ gem install fluent-plugin-jfrog-send-metrics
```

### Setup & configuration

Fluentd is the supported log collector for this integration. For Fluentd setup and information, read the JFrog log analytics repository's [README](https://github.com/jfrog/log-analytics/blob/master/README.md).

#### Fluentd config

Configure the match directive parameters as specified below

```
<match jfrog.metrics.**>
  @type jfrog_send_metrics
  target_platform "NEWRELIC" # or "DATADOG"
  apikey <api_key>
  url https://metric-api.newrelic.com/metric/v1 # or DataDog's metrics URL
  http_proxy <proxy_url>
</match>
```

#### Configuration parameters

Obtain respective authentication credentials for log-vendors

* **target_platform**(string)(required): The target log-vendor ("NEWRELIC" or "DATADOG")
* **apikey**(string)(required): APIKEY is the apikey of log-vendor for authentication(LicenseKey for NewRelic)
* **url**(string)(required): Metrics url of the mertics-vendor (Metrics URL for NewRelic or DataDog)
* **http_proxy**(string)(optional): Proxy server URL - which will proxy http/s calls to your observability vendor (DataDog/NewRelic)
* **verify_ssl** (true / false) (optional): This flag should be set as false in order to bypass client's ssl certificate verification. When false, sets ssl_opts['verify_ssl'] to OpenSSL::SSL::VERIFY_NONE. Otherwise, sets ssl_opts['verify_ssl'] to OpenSSL::SSL::VERIFY_PEER
  * Default value: true
* **gzip_compression** (true / false) (optional): This flag should be set as true for compressing (gzip) the metrics payload on outbound posts. This parameter is set to false by default for backwards compatibility.
  * Default value: false
* **request_timeout** (integer) (optional): Http request timeout when calling Artifactory/Xray to pull new events (http client)
  * Default value: `20`

## Copyright

* Copyright(c) 2024 - JFrog
* Maintainers - MahithaB, BenHarosh
* License
  * Apache License, Version 2.0