You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by jb...@apache.org on 2013/10/01 21:26:06 UTC
[2/3] git commit: Add configurable metrics reporting patch by Chris
Burroughs; reviewed by Tyler Hobbs for CASSANDRA-4430
Add configurable metrics reporting
patch by Chris Burroughs; reviewed by Tyler Hobbs for CASSANDRA-4430
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/32c3f44a
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/32c3f44a
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/32c3f44a
Branch: refs/heads/trunk
Commit: 32c3f44a684a1208bf9d43c18079ba45aa8e2fa6
Parents: dc7221f
Author: Jonathan Ellis <jb...@apache.org>
Authored: Tue Oct 1 14:25:42 2013 -0500
Committer: Jonathan Ellis <jb...@apache.org>
Committed: Tue Oct 1 14:25:42 2013 -0500
----------------------------------------------------------------------
CHANGES.txt | 1 +
NEWS.txt | 2 +
build.xml | 2 +
conf/metrics-reporter-config-sample.yaml | 41 +++++
lib/licenses/reporter-config-2.1.0.txt | 177 +++++++++++++++++++
lib/reporter-config-2.1.0.jar | Bin 0 -> 22291 bytes
.../cassandra/service/CassandraDaemon.java | 18 ++
7 files changed, 241 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 9bd01ef..80aed13 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,4 +1,5 @@
2.0.2
+ * Add configurable metrics reporting (CASSANDRA-4430)
* drop queries exceeding a configurable number of tombstones (CASSANDRA-6117)
* Track and persist sstable read activity (CASSANDRA-5515)
* Fixes for speculative retry (CASSANDRA-5932)
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/NEWS.txt
----------------------------------------------------------------------
diff --git a/NEWS.txt b/NEWS.txt
index 747234f..6ed8449 100644
--- a/NEWS.txt
+++ b/NEWS.txt
@@ -21,6 +21,8 @@ New features
------------
- Speculative retry defaults to 99th percentile
(See blog post at TODO)
+ - Configurable metrics reporting
+ (see conf/metrics-reporter-config-sample.yaml)
Upgrading
---------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/build.xml
----------------------------------------------------------------------
diff --git a/build.xml b/build.xml
index 5731540..4be1d10 100644
--- a/build.xml
+++ b/build.xml
@@ -373,6 +373,7 @@
<dependency groupId="org.apache.cassandra" artifactId="cassandra-all" version="${version}" />
<dependency groupId="org.apache.cassandra" artifactId="cassandra-thrift" version="${version}" />
<dependency groupId="com.yammer.metrics" artifactId="metrics-core" version="2.2.0" />
+ <dependency groupId="com.addthis.metrics" artifactId="reporter-config" version="2.1.0" />
<dependency groupId="edu.stanford.ppl" artifactId="snaptree" version="0.1" />
<dependency groupId="org.mindrot" artifactId="jbcrypt" version="0.3m" />
<dependency groupId="io.netty" artifactId="netty" version="3.6.6.Final" />
@@ -452,6 +453,7 @@
<dependency groupId="edu.stanford.ppl" artifactId="snaptree"/>
<dependency groupId="org.mindrot" artifactId="jbcrypt"/>
<dependency groupId="com.yammer.metrics" artifactId="metrics-core"/>
+ <dependency groupId="com.addthis.metrics" artifactId="reporter-config"/>
<dependency groupId="com.thinkaurelius.thrift" artifactId="thrift-server" version="0.3.2"/>
<dependency groupId="log4j" artifactId="log4j"/>
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/conf/metrics-reporter-config-sample.yaml
----------------------------------------------------------------------
diff --git a/conf/metrics-reporter-config-sample.yaml b/conf/metrics-reporter-config-sample.yaml
new file mode 100644
index 0000000..34b1d7e
--- /dev/null
+++ b/conf/metrics-reporter-config-sample.yaml
@@ -0,0 +1,41 @@
+# For details see:
+# * http://wiki.apache.org/cassandra/Metrics
+# * https://github.com/addthis/metrics-reporter-config
+
+# This is an example file for configuring which metrics should go
+# where. The sample sends everything to a flat file for humans to
+# poke at. metrics-ganglia or metrics-graphite are more likely to
+# operationally useful.
+
+# Some metrics are global for a node (KeyCache capacity) while others
+# are broken down by column family or even IP. The sample list
+# includes all of the global metrics via a while list. To include
+# metrics for the system column family for example add
+# "^org.apache.cassandra.metrics.ColumnFamily.system.+".
+
+
+# Start Cassandra with
+# -Dcassandra.metricsReporterConfigFile=metrics-reporter-config.yaml
+# for this file to be used. If you are using metrics-ganglia,
+# metrics-graphite, or a custom reporter you will also have to add those
+# jars to the lib directory. Nothing in this file can affect
+# jmx metrics.
+
+
+console:
+ -
+ outfile: '/tmp/metrics.out'
+ period: 10
+ timeunit: 'SECONDS'
+ predicate:
+ color: "white"
+ useQualifiedName: true
+ patterns:
+ - "^org.apache.cassandra.metrics.Cache.+"
+ - "^org.apache.cassandra.metrics.ClientRequest.+" # includes ClientRequestMetrics
+ - "^org.apache.cassandra.metrics.CommitLog.+"
+ - "^org.apache.cassandra.metrics.Compaction.+"
+ - "^org.apache.cassandra.metrics.DroppedMetrics.+"
+ - "^org.apache.cassandra.metrics.ReadRepair.+"
+ - "^org.apache.cassandra.metrics.Storage.+"
+ - "^org.apache.cassandra.metrics.ThreadPools.+"
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/lib/licenses/reporter-config-2.1.0.txt
----------------------------------------------------------------------
diff --git a/lib/licenses/reporter-config-2.1.0.txt b/lib/licenses/reporter-config-2.1.0.txt
new file mode 100644
index 0000000..430d42b
--- /dev/null
+++ b/lib/licenses/reporter-config-2.1.0.txt
@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/lib/reporter-config-2.1.0.jar
----------------------------------------------------------------------
diff --git a/lib/reporter-config-2.1.0.jar b/lib/reporter-config-2.1.0.jar
new file mode 100644
index 0000000..0e13098
Binary files /dev/null and b/lib/reporter-config-2.1.0.jar differ
http://git-wip-us.apache.org/repos/asf/cassandra/blob/32c3f44a/src/java/org/apache/cassandra/service/CassandraDaemon.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/cassandra/service/CassandraDaemon.java b/src/java/org/apache/cassandra/service/CassandraDaemon.java
index ae8a5a2..f7e8af4 100644
--- a/src/java/org/apache/cassandra/service/CassandraDaemon.java
+++ b/src/java/org/apache/cassandra/service/CassandraDaemon.java
@@ -31,6 +31,8 @@ import javax.management.MBeanServer;
import javax.management.ObjectName;
import javax.management.StandardMBean;
+import com.addthis.metrics.reporter.config.ReporterConfig;
+
import com.google.common.collect.Iterables;
import com.google.common.collect.SetMultimap;
@@ -352,6 +354,22 @@ public class CassandraDaemon
Mx4jTool.maybeLoad();
+ // Metrics
+ String metricsReporterConfigFile = System.getProperty("cassandra.metricsReporterConfigFile");
+ if (metricsReporterConfigFile != null)
+ {
+ logger.info("Trying to load metrics-reporter-config from file: {}", metricsReporterConfigFile);
+ try
+ {
+ String reportFileLocation = CassandraDaemon.class.getClassLoader().getResource(metricsReporterConfigFile).getFile();
+ ReporterConfig.loadFromFile(reportFileLocation).enableAll();
+ }
+ catch (Exception e)
+ {
+ logger.warn("Failed to load metrics-reporter-config, metric sinks will not be activated", e);
+ }
+ }
+
// Thift
InetAddress rpcAddr = DatabaseDescriptor.getRpcAddress();
int rpcPort = DatabaseDescriptor.getRpcPort();