JarCasting
JarCasting JarCasting

elasticsearch-cloudwatch

An Elasticserch plugin which pushes node statistics to AWS Cloudwatch

License

License
Categories

Categories

Search Business Logic Libraries Elasticsearch
GroupId

GroupId

com.gu
ArtifactId

ArtifactId

elasticsearch-cloudwatch
Last Version

Last Version

1.1
Release Date

Release Date
Type

Type

jar
Description

Description

elasticsearch-cloudwatch
An Elasticserch plugin which pushes node statistics to AWS Cloudwatch
Project URL

Project URL

https://github.com/guardian/elasticsearch-cloudwatch
Source Code Management

Source Code Management

https://github.com/guardian/elasticsearch-cloudwatch

Download elasticsearch-cloudwatch

Filename Size
elasticsearch-cloudwatch-1.1.pom
elasticsearch-cloudwatch-1.1.zip 21 MB
elasticsearch-cloudwatch-1.1-sources.jar 11 KB
elasticsearch-cloudwatch-1.1-javadoc.jar 33 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.gu/elasticsearch-cloudwatch/ -->
<dependency>
    <groupId>com.gu</groupId>
    <artifactId>elasticsearch-cloudwatch</artifactId>
    <version>1.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.gu/elasticsearch-cloudwatch/
implementation 'com.gu:elasticsearch-cloudwatch:1.1'
// https://jarcasting.com/artifacts/com.gu/elasticsearch-cloudwatch/
implementation ("com.gu:elasticsearch-cloudwatch:1.1")
'com.gu:elasticsearch-cloudwatch:jar:1.1'
<dependency org="com.gu" name="elasticsearch-cloudwatch" rev="1.1">
  <artifact name="elasticsearch-cloudwatch" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.gu', module='elasticsearch-cloudwatch', version='1.1')
)
libraryDependencies += "com.gu" % "elasticsearch-cloudwatch" % "1.1"
[com.gu/elasticsearch-cloudwatch "1.1"]

Dependencies

compile (3)

Group / Artifact Type Version
junit : junit jar 4.8.2
org.elasticsearch : elasticsearch jar 1.7.1
com.amazonaws : aws-java-sdk jar 1.10.16

Project Modules

There are no modules declared in this project.

elasticsearch-cloudwatch

This is an Elasticsearch plugin which posts ES stats to CloudWatch.

Generating the installable plugin

To generate the plugin for installation you need to use maven:

$ mvn clean package

Installing the plugin

Install it from the Elasticsearch installation directory, by running (change the location of your file):

$ bin/plugin -url https://github.com/guardian/elasticsearch-cloudwatch/releases/download/1.2/elasticsearch-CloudwatchPlugin-1.2.zip -install CloudwatchPlugin

To uninstall it you can run:

$ bin/plugin -remove CloudwatchPlugin

Configuring the plugin

The plugin has some options that you can configure in the elasticsearch.yml:

  • metrics.cloudwatch.enabled: To enable or disable the plugin itself. True by default.
  • metrics.cloudwatch.aws.region: Which region to use, of the AWS account. Default is eu-west-1
  • metrics.cloudwatch.frequency: How often to post stats. Default is "1m", every minute.
  • metrics.cloudwatch.index_stats_enabled: To enable or disable stats per index. You don't want the explosion of metrics if you have too many indexes, such as for example with Logstash where there is an index per day. False by default.
  • metrics.cloudwatch metrics.cloudwatch.namespace: To set the cloudwatch namespace of the metric.

AWS Credentials

  • metrics.cloudwatch.aws.access_key
  • metrics.cloudwatch.aws.secret_key

If these keys aren't set, the plugin will attempt to use system properties, environment variables and IAM role credentials if available.

Acknowledgements

This plugin is forked from https://github.com/9apps/elasticsearch-cloudwatch

com.gu

The Guardian

The source code of the world's leading liberal voice

Versions

Version
1.1
1.0