├── .gitignore
├── .travis.yml
├── .travis
    ├── script.sh
    └── settings.xml
├── LICENSE
├── README.md
├── pom.xml
└── src
    ├── main
        ├── java
        │   └── org
        │   │   └── dhatim
        │   │       └── io
        │   │           └── dropwizard
        │   │               └── metrics
        │   │                   └── elasticsearch
        │   │                       └── ElasticSearchReporterFactory.java
        └── resources
        │   └── META-INF
        │       └── services
        │           └── io.dropwizard.metrics.ReporterFactory
    └── test
        └── java
            └── org
                └── dhatim
                    └── io
                        └── dropwizard
                            └── metrics
                                └── elasticsearch
                                    └── ElasticSearchReporterFactoryTest.java


/.gitignore:
--------------------------------------------------------------------------------
1 | /target/


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 | jdk: oraclejdk8
3 | install: true
4 | script: . .travis/script.sh
5 | 


--------------------------------------------------------------------------------
/.travis/script.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | if [ "${TRAVIS_EVENT_TYPE}" == push ] &&
 4 |        echo "${TRAVIS_TAG}" | egrep '^[0-9]+\.[0-9]+\.[0-9]+$'
 5 | then
 6 |     # the build is triggered by a tag push, and the tag looks like
 7 |     # a version number: proceed with release
 8 |     echo ${GPG_SECRET_KEY} | base64 --decode | gpg --import
 9 |     echo ${GPG_OWNERTRUST} | base64 --decode | gpg --import-ownertrust
10 |     mvn versions:set -DnewVersion=${TRAVIS_TAG}
11 |     mvn -s .travis/settings.xml -Prelease deploy
12 | else
13 |     # this is a regular build
14 |     mvn install
15 | fi
16 | 


--------------------------------------------------------------------------------
/.travis/settings.xml:
--------------------------------------------------------------------------------
 1 | <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
 2 |     <servers>
 3 |         <server>
 4 |             <id>ossrh</id>
 5 |             <username>${env.SONATYPE_USERNAME}</username>
 6 |             <password>${env.SONATYPE_PASSWORD}</password>
 7 |         </server>
 8 |     </servers>
 9 |     <profiles>
10 |         <profile>
11 |             <id>ossrh</id>
12 |             <activation>
13 |                 <activeByDefault>true</activeByDefault>
14 |             </activation>
15 |             <properties>
16 |                 <gpg.passphrase>${env.GPG_PASSPHRASE}</gpg.passphrase>
17 |             </properties>
18 |         </profile>
19 |     </profiles>
20 | </settings>
21 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright 2015 Dhatim
 2 | 
 3 | Licensed under the Apache License, Version 2.0 (the "License");
 4 | you may not use this file except in compliance with the License.
 5 | You may obtain a copy of the License at
 6 | 
 7 |     http://www.apache.org/licenses/LICENSE-2.0
 8 | 
 9 | Unless required by applicable law or agreed to in writing, software
10 | distributed under the License is distributed on an "AS IS" BASIS,
11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | See the License for the specific language governing permissions and
13 | limitations under the License.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Dropwizard Metrics Support for Elastic Search
 2 | 
 3 | [![Build Status](https://travis-ci.org/dhatim/dropwizard-metrics-elasticsearch.png?branch=master)](https://travis-ci.org/dhatim/dropwizard-metrics-elasticsearch)
 4 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.dhatim.io.dropwizard/dropwizard-metrics-elasticsearch/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.dhatim.io.dropwizard/dropwizard-metrics-elasticsearch)
 5 | 
 6 | This modules enables a [dropwizard][dw] application to send
 7 | [metrics][dwm] to an [elasticsearch][e] instance.
 8 | 
 9 | ## What about [Metrics Elasticsearch Reporter][mer]? Doesn't it do just that?
10 | 
11 | [No, it doesn't][dwi]. As outlined [here][merc], it needs you to write
12 | some code in your application. This module adds the ability to perform
13 | that task through your dropwizard application yaml configuration. In
14 | fact, under the hood it actually makes use of
15 | [Metrics Elasticsearch Reporter][mer] to perform the work.
16 | 
17 | ## How to
18 | 
19 | - add this jar as a dependency to the dropwizard app:
20 | 
21 | ```xml
22 | <dependencies>
23 |     ../..
24 |     <dependency>
25 |         <groupId>org.dhatim.io.dropwizard</groupId>
26 |         <artifactId>dropwizard-metrics-elasticsearch</artifactId>
27 |         <version>1.0.8</version>
28 |     </dependency>
29 |     ../..
30 | </dependencies>
31 | ```
32 | 
33 | - enable the metrics reporter through the configuration:
34 | 
35 | ```yaml
36 | metrics:
37 |   reporters:
38 |     - type: elasticsearch
39 | ```
40 | 
41 | and you're good to go.
42 | 
43 | ## configuration
44 | 
45 | The configuration is somewhat limited right now:
46 | 
47 | - servers: you can configure a set of elasticsearch nodes with the
48 | `servers` key, which hold a collection of `host` and `port` keys.
49 | - prefix: useful to identify single hosts.
50 | - index: elasticsearch index name.
51 | - indexDateFormat: elasticsearch index date format.
52 | - additionalFields: optional map of additional field values.
53 | 
54 | ### default values
55 | 
56 | ```yaml
57 | metrics:
58 |   reporters:
59 |     - type: elasticsearch
60 |       servers:
61 |         - host: localhost
62 |           port: 9200
63 |       prefix:
64 |       index: metrics
65 |       indexDateFormat: yyyy.MM.dd
66 |       additionalFields:
67 | ```
68 | 
69 | It should basically follow the [Metrics Elasticsearch Reporter][mer]
70 | defaults.
71 | 
72 | [dw]: http://www.dropwizard.io
73 | [dwm]: http://metrics.dropwizard.io
74 | [e]: https://www.elastic.co/products/elasticsearch
75 | [mer]: https://github.com/elastic/elasticsearch-metrics-reporter-java
76 | [dwi]: https://github.com/dropwizard/dropwizard/issues/1277
77 | [merc]: https://github.com/elastic/elasticsearch-metrics-reporter-java#configuration
78 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 | 
  5 |     <groupId>org.dhatim.io.dropwizard</groupId>
  6 |     <artifactId>dropwizard-metrics-elasticsearch</artifactId>
  7 |     <version>0-SNAPSHOT</version>
  8 | 
  9 |     <name>${project.groupId}:${project.artifactId}</name>
 10 |     <description>Dropwizard Metrics Support for Elastic Search</description>
 11 |     <url>https://github.com/dhatim/dropwizard-metrics-elasticsearch</url>
 12 | 
 13 |     <licenses>
 14 |         <license>
 15 |             <name>The Apache License, Version 2.0</name>
 16 |             <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
 17 |         </license>
 18 |     </licenses>
 19 | 
 20 |     <developers>
 21 |         <developer>
 22 |             <organization>Dhatim</organization>
 23 |             <organizationUrl>http://dhatim.com</organizationUrl>
 24 |         </developer>
 25 |     </developers>
 26 |     
 27 |     <scm>
 28 |         <connection>scm:git:git://github.com/dhatim/dropwizard-metrics-elasticsearch.git</connection>
 29 |         <developerConnection>scm:git:ssh://github.com:dhatim/dropwizard-metrics-elasticsearch.git</developerConnection>
 30 |         <url>https://github.com/dhatim/dropwizard-metrics-elasticsearch/tree/${project.version}</url>
 31 |     </scm>
 32 | 
 33 |     <distributionManagement>
 34 |         <snapshotRepository>
 35 |             <id>ossrh</id>
 36 |             <url>https://oss.sonatype.org/content/repositories/snapshots</url>
 37 |         </snapshotRepository>
 38 |     </distributionManagement>
 39 | 
 40 |     <prerequisites>
 41 |         <maven>3.0.4</maven>
 42 |     </prerequisites>
 43 | 
 44 |     <properties>
 45 |         <maven.compiler.source>1.8</maven.compiler.source>
 46 |         <maven.compiler.target>1.8</maven.compiler.target>
 47 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 48 |         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 49 |     </properties>
 50 | 
 51 |     <build>
 52 |         <pluginManagement>
 53 |             <plugins>
 54 |                 <plugin>
 55 |                     <artifactId>maven-clean-plugin</artifactId>
 56 |                     <version>3.0.0</version>
 57 |                 </plugin>
 58 |                 <plugin>
 59 |                     <artifactId>maven-compiler-plugin</artifactId>
 60 |                     <version>3.5.1</version>
 61 |                 </plugin>
 62 |                 <plugin>
 63 |                     <artifactId>maven-deploy-plugin</artifactId>
 64 |                     <version>2.8.2</version>
 65 |                 </plugin>
 66 |                 <plugin>
 67 |                     <artifactId>maven-gpg-plugin</artifactId>
 68 |                     <version>1.6</version>
 69 |                 </plugin>
 70 |                 <plugin>
 71 |                     <artifactId>maven-install-plugin</artifactId>
 72 |                     <version>2.5.2</version>
 73 |                 </plugin>
 74 |                 <plugin>
 75 |                     <artifactId>maven-jar-plugin</artifactId>
 76 |                     <version>3.0.2</version>
 77 |                 </plugin>
 78 |                 <plugin>
 79 |                     <artifactId>maven-javadoc-plugin</artifactId>
 80 |                     <version>2.10.4</version>
 81 |                 </plugin>
 82 |                 <plugin>
 83 |                     <artifactId>maven-resources-plugin</artifactId>
 84 |                     <version>3.0.1</version>
 85 |                 </plugin>
 86 |                 <plugin>
 87 |                     <artifactId>maven-site-plugin</artifactId>
 88 |                     <version>3.5.1</version>
 89 |                 </plugin>
 90 |                 <plugin>
 91 |                     <artifactId>maven-source-plugin</artifactId>
 92 |                     <version>3.0.1</version>
 93 |                 </plugin>
 94 |                 <plugin>
 95 |                     <artifactId>maven-surefire-plugin</artifactId>
 96 |                     <version>2.19.1</version>
 97 |                 </plugin>
 98 |                 <plugin>
 99 |                     <groupId>org.sonatype.plugins</groupId>
100 |                     <artifactId>nexus-staging-maven-plugin</artifactId>
101 |                     <version>1.6.7</version>
102 |                 </plugin>
103 |             </plugins>
104 |         </pluginManagement>
105 |     </build>
106 |     
107 |     <profiles>
108 |         <profile>
109 |             <id>release</id>
110 |             <build>
111 |                 <plugins>
112 |                     <plugin>
113 |                         <artifactId>maven-gpg-plugin</artifactId>
114 |                         <executions>
115 |                             <execution>
116 |                                 <id>sign-artifacts</id>
117 |                                 <phase>verify</phase>
118 |                                 <goals>
119 |                                     <goal>sign</goal>
120 |                                 </goals>
121 |                             </execution>
122 |                         </executions>
123 |                     </plugin>
124 |                     <plugin>
125 |                         <artifactId>maven-javadoc-plugin</artifactId>
126 |                         <configuration>
127 |                             <quiet>true</quiet>
128 |                         </configuration>
129 |                         <executions>
130 |                             <execution>
131 |                                 <id>attach-javadocs</id>
132 |                                 <goals>
133 |                                     <goal>jar</goal>
134 |                                 </goals>
135 |                             </execution>
136 |                         </executions>
137 |                     </plugin>
138 |                     <plugin>
139 |                         <artifactId>maven-source-plugin</artifactId>
140 |                         <executions>
141 |                             <execution>
142 |                                 <id>attach-sources</id>
143 |                                 <goals>
144 |                                     <goal>jar-no-fork</goal>
145 |                                 </goals>
146 |                             </execution>
147 |                         </executions>
148 |                     </plugin>
149 |                     <plugin>
150 |                         <groupId>org.sonatype.plugins</groupId>
151 |                         <artifactId>nexus-staging-maven-plugin</artifactId>
152 |                         <extensions>true</extensions>
153 |                         <configuration>
154 |                             <serverId>ossrh</serverId>
155 |                             <nexusUrl>https://oss.sonatype.org</nexusUrl>
156 |                             <autoReleaseAfterClose>true</autoReleaseAfterClose>
157 |                         </configuration>
158 |                     </plugin>
159 |                 </plugins>
160 |             </build>
161 |         </profile>
162 |     </profiles>
163 | 
164 |     <dependencies>
165 |         <dependency>
166 |             <groupId>org.elasticsearch</groupId>
167 |             <artifactId>metrics-elasticsearch-reporter</artifactId>
168 |             <version>2.2.0</version>
169 |             <exclusions>
170 |                 <exclusion>
171 |                     <groupId>com.codahale.metrics</groupId>
172 |                     <artifactId>metrics-core</artifactId>
173 |                 </exclusion>
174 |                 <exclusion>
175 |                     <groupId>com.fasterxml.jackson.core</groupId>
176 |                     <artifactId>jackson-databind</artifactId>
177 |                 </exclusion>
178 |             </exclusions>
179 |         </dependency>
180 |         <dependency>
181 |             <groupId>io.dropwizard</groupId>
182 |             <artifactId>dropwizard-metrics</artifactId>
183 |             <version>1.0.2</version>
184 |             <scope>provided</scope>
185 |         </dependency>
186 |         <dependency>
187 |             <groupId>junit</groupId>
188 |             <artifactId>junit</artifactId>
189 |             <version>4.12</version>
190 |             <scope>test</scope>
191 |         </dependency>
192 |         <dependency>
193 |             <groupId>org.assertj</groupId>
194 |             <artifactId>assertj-core</artifactId>
195 |             <version>3.5.2</version>
196 |             <scope>test</scope>
197 |         </dependency>
198 |     </dependencies>    
199 | </project>
200 | 


--------------------------------------------------------------------------------
/src/main/java/org/dhatim/io/dropwizard/metrics/elasticsearch/ElasticSearchReporterFactory.java:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2016 Dhatim
 3 |  *
 4 |  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 5 |  * use this file except in compliance with the License. You may obtain a copy of
 6 |  * the License at
 7 |  *
 8 |  * http://www.apache.org/licenses/LICENSE-2.0
 9 |  *
10 |  * Unless required by applicable law or agreed to in writing, software
11 |  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 |  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 |  * License for the specific language governing permissions and limitations under
14 |  * the License.
15 |  */
16 | package org.dhatim.io.dropwizard.metrics.elasticsearch;
17 | 
18 | import com.codahale.metrics.MetricRegistry;
19 | import com.codahale.metrics.ScheduledReporter;
20 | import com.fasterxml.jackson.annotation.JsonTypeName;
21 | import io.dropwizard.metrics.BaseReporterFactory;
22 | import java.io.IOException;
23 | import java.util.Arrays;
24 | import java.util.Map;
25 | import org.elasticsearch.metrics.ElasticsearchReporter;
26 | import org.hibernate.validator.constraints.NotEmpty;
27 | import org.hibernate.validator.constraints.Range;
28 | 
29 | @JsonTypeName("elasticsearch")
30 | public class ElasticSearchReporterFactory extends BaseReporterFactory {
31 |     
32 |     public static class Server {
33 |         
34 |         @NotEmpty
35 |         public String host = "localhost";
36 |         
37 |         @Range(min = 1, max = 49151)
38 |         public int port = 9200;
39 |         
40 |         public Server() {
41 |         }
42 |         
43 |         public Server(String host, int port) {
44 |             this.host = host;
45 |             this.port = port;
46 |         }
47 |     }
48 |     
49 |     public Server[] servers = new Server[]{new Server("localhost", 9200)};
50 |     
51 |     public String prefix = "";
52 |     
53 |     public String index = "metrics";
54 |     
55 |     public String indexDateFormat = "yyyy.MM.dd";
56 |     
57 |     public Map<String, Object> additionalFields;
58 |     
59 |     @Override
60 |     public ScheduledReporter build(MetricRegistry registry) {
61 |         try {
62 |             String[] hosts = Arrays.stream(servers)
63 |                     .map(s -> s.host + ":" + s.port)
64 |                     .toArray(String[]::new);
65 |             
66 |             return ElasticsearchReporter.forRegistry(registry)
67 |                     .hosts(hosts)
68 |                     .prefixedWith(prefix)
69 |                     .index(index)
70 |                     .indexDateFormat(indexDateFormat)
71 |                     .additionalFields(additionalFields)
72 |                     .build();
73 |         } catch (IOException e) {
74 |             throw new RuntimeException("can't build elasticsearch reporter", e);
75 |         }
76 |     }
77 | }
78 | 


--------------------------------------------------------------------------------
/src/main/resources/META-INF/services/io.dropwizard.metrics.ReporterFactory:
--------------------------------------------------------------------------------
1 | org.dhatim.io.dropwizard.metrics.elasticsearch.ElasticSearchReporterFactory


--------------------------------------------------------------------------------
/src/test/java/org/dhatim/io/dropwizard/metrics/elasticsearch/ElasticSearchReporterFactoryTest.java:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright 2015 Dhatim
 3 |  *
 4 |  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 5 |  * use this file except in compliance with the License. You may obtain a copy of
 6 |  * the License at
 7 |  *
 8 |  * http://www.apache.org/licenses/LICENSE-2.0
 9 |  *
10 |  * Unless required by applicable law or agreed to in writing, software
11 |  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 |  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 |  * License for the specific language governing permissions and limitations under
14 |  * the License.
15 |  */
16 | package org.dhatim.io.dropwizard.metrics.elasticsearch;
17 | 
18 | import io.dropwizard.jackson.DiscoverableSubtypeResolver;
19 | import static org.assertj.core.api.Assertions.assertThat;
20 | import org.junit.Test;
21 | 
22 | public class ElasticSearchReporterFactoryTest {
23 | 
24 |     @Test
25 |     public void isDiscoverable() throws Exception {
26 |         assertThat(new DiscoverableSubtypeResolver().getDiscoveredSubtypes())
27 |                 .contains(ElasticSearchReporterFactory.class);
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------