Updated some metric descriptions based on feedback (#38)

* Updated some metric descriptions based on feedback

* Changed date format in changelog of newest entry

Author: Corbin Phelps

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.0.0 - 2019-01-09
+### Changed
+- Updated some metric names and fixed some descriptions in the spec.csv
+
 ## 1.2.0 - 2018-11-29
 ### Added
 - Cluster name is now attached to allow entities within a cluster

spec.csv

@@ -12,7 +12,7 @@ elasticsearch,breakers.requestCircuitBreakerTripped,gauge,true,The number of tim
 elasticsearch,cache.cacheSizeIDInBytes,gauge,true,The size of the id cache shown in bytes
 elasticsearch,cluster.dataNodes,gauge,true,The number of data nodes in the cluster
 elasticsearch,cluster.nodes,gauge,true,The number of nodes in the cluster
-elasticsearch,cluster.status,gauge,true,"The elasticsearch cluster health as a number: red = 0, yellow = 1, green = 2"
+elasticsearch,cluster.status,gauge,true,"The elasticsearch cluster health: red, yellow, or green"
 elasticsearch,currentActiveQueries,gauge,true,The number of currently active queries
 elasticsearch,currentActiveQueriesInMilliseconds,gauge,true,The time spent on queries
 elasticsearch,flush.indexFlushDisk,gauge,true,The number of index flushes to disk since start
@@ -37,7 +37,7 @@ elasticsearch,http.currentOpenConnections,gauge,true,The number of current open
 elasticsearch,http.openedConnections,gauge,true,The number of opened HTTP connections
 elasticsearch,index.docs,gauge,true,The number of documents in the index
 elasticsearch,index.docsDeleted,gauge,true,The number of deleted documents in the index
-elasticsearch,index.health,gauge,true,The status of the index
+elasticsearch,index.health,gauge,true,"The status of the index: read, yellow, or green"
 elasticsearch,index.primaryShards,gauge,true,The number of primary shards in the index
 elasticsearch,index.primaryStoreSizeInBytes,gauge,true,The store size of primary shards in the index
 elasticsearch,index.replicaShards,gauge,true,The number of replica shards in the index
@@ -134,14 +134,14 @@ elasticsearch,jvm.gc.collections,gauge,true,The number of garbage collections ru
 elasticsearch,jvm.gc.collectionsInMilliseconds,gauge,true,The time spent on garbage collection in the JVM
 elasticsearch,jvm.gc.majorCollectionsOldGenerationObjectsInMilliseconds,gauge,true,The time spent in major GCs in the JVM that collect old generation objects
 elasticsearch,jvm.gc.majorCollectionsOldGenerationObjects,gauge,true,The number of major GCs in the JVM that collect old generation objects
-elasticsearch,jvm.gc.majorCollectionsYoungGenerationObjectsInMilliseconds,gauge,true,The time spent in minor GCs in the JVM that collects young generation objects
-elasticsearch,jvm.gc.majorCollectionsYoungGenerationObjects,gauge,true,The number of minor GCs in the JVM that collects young generation objects
+elasticsearch,jvm.gc.minorCollectionsYoungGenerationObjectsInMilliseconds,gauge,true,The time spent in minor GCs in the JVM that collects young generation objects
+elasticsearch,jvm.gc.minorCollectionsYoungGenerationObjects,gauge,true,The number of minor GCs in the JVM that collects young generation objects
 elasticsearch,jvm.gc.concurrentMarkSweepInMilliseconds,gauge,true,"The time spent on ""concurrent mark & sweep"" GCs in the JVM"
 elasticsearch,jvm.gc.concurrentMarkSweep,gauge,true,"The number of ""concurrent mark & sweep"" GCs in the JVM"
 elasticsearch,jvm.gc.parallelNewCollectionsInMilliseconds,gauge,true,"The time spent on ""parallel new"" GCs in the JVM"
 elasticsearch,jvm.gc.parallelNewCollections,gauge,true,"The number of ""parallel new"" GCs in the JVM"
 elasticsearch,jvm.mem.heapCommittedInBytes,gauge,true,The amount of memory guaranteed to be available to the JVM heapshown in bytes
-elasticsearch,jvm.mem.heapUsed,gauge,true,The amount of memory currently used by the JVM heap as a value between 0 and 1
+elasticsearch,jvm.mem.heapUsed,gauge,true,The percentage of memory currently used by the JVM heap as a value between 0 and 1
 elasticsearch,jvm.mem.heapMaxInBytes,gauge,true,The maximum amount of memory that can be used by the JVM heapshown in bytes
 elasticsearch,jvm.mem.heapUsedInBytes,gauge,true,The amount of memory in bytes currently used by the JVM heapshown in bytes
 elasticsearch,jvm.mem.nonHeapCommittedInBytes,gauge,true,The amount of memory guaranteed to be available to JVM non-heapshown in bytes
@@ -158,7 +158,7 @@ elasticsearch,threadpool.bulkActive,gauge,true,The number of active threads in t
 elasticsearch,threadpool.bulk.Aueue,gauge,true,The number of queued threads in the bulk pool
 elasticsearch,threadpool.bulkThreads,gauge,true,The number of threads in the bulk pool
 elasticsearch,threadpool.bulkRejected,gauge,true,The number of rejected threads in the bulk pool
-elasticsearch,threadpoolActivefetchShardStarted,gauge,true,The number of active threads in the fetch shard started pool
+elasticsearch,threadpool.activeFetchShardStarted,gauge,true,The number of active threads in the fetch shard started pool
 elasticsearch,threadpool.fetchShardStartedThreads,gauge,true,The number of threads in the fetch shard started pool
 elasticsearch,threadpool.fetchShardStartedQueue,gauge,true,The number of queued threads in the fetch shard started pool
 elasticsearch,threadpool.fetchShardStartedRejected,gauge,true,The number of rejected threads in the fetch shard started pool

src/elasticsearch.go

@@ -28,7 +28,7 @@ type argumentList struct {
 
 const (
 	integrationName    = "com.newrelic.elasticsearch"
-	integrationVersion = "1.2.0"
+	integrationVersion = "2.0.0"
 )
 
 var (

src/metric_definition.go

@@ -398,14 +398,14 @@ type CollectorsOld struct {
 
 // CollectorsYoung struct
 type CollectorsYoung struct {
-	CollectionTimeInMillis *int `json:"collection_time_in_millis" metric_name:"jvm.gc.majorCollectionsYoungGenerationObjectsInMilliseconds" source_type:"gauge"`
-	CollectionCount        *int `json:"collection_count" metric_name:"jvm.gc.majorCollectionsYoungGenerationObjects" source_type:"gauge"`
+	CollectionTimeInMillis *int `json:"collection_time_in_millis" metric_name:"jvm.gc.minorCollectionsYoungGenerationObjectsInMilliseconds" source_type:"gauge"`
+	CollectionCount        *int `json:"collection_count" metric_name:"jvm.gc.minorCollectionsYoungGenerationObjects" source_type:"gauge"`
 }
 
 // JvmMem struct
 type JvmMem struct {
 	HeapCommittedInBytes    *int      `json:"heap_committed_in_bytes" metric_name:"jvm.mem.heapCommittedInBytes" source_type:"gauge"`
-	HeapInUse               *int      `json:"heap_in_use" metric_name:"jvm.mem.heapUsed" source_type:"gauge"`
+	HeapInUse               *int      `json:"heap_used_percent" metric_name:"jvm.mem.heapUsed" source_type:"gauge"`
 	HeapMaxInBytes          *int      `json:"heap_max_in_bytes" metric_name:"jvm.mem.heapMaxInBytes" source_type:"gauge"`
 	HeapUsedInBytes         *int      `json:"heap_used_in_bytes" metric_name:"jvm.mem.heapUsedInBytes" source_type:"gauge"`
 	NonHeapCommittedInBytes *int      `json:"non_heap_committed_in_bytes" metric_name:"jvm.mem.nonHeapCommittedInBytes" source_type:"gauge"`
@@ -473,7 +473,7 @@ type ThreadPoolBulk struct {
 
 // ThreadPoolFetchShardStarted struct
 type ThreadPoolFetchShardStarted struct {
-	Active   *int `json:"active" metric_name:"threadpoolActivefetchShardStarted" source_type:"gauge"`
+	Active   *int `json:"active" metric_name:"threadpool.activeFetchShardStarted" source_type:"gauge"`
 	Queue    *int `json:"queue" metric_name:"threadpool.fetchShardStartedThreads" source_type:"gauge"`
 	Threads  *int `json:"threads" metric_name:"threadpool.fetchShardStartedQueue" source_type:"gauge"`
 	Rejected *int `json:"rejected" metric_name:"threadpool.fetchShardStartedRejected" source_type:"gauge"`

src/testdata/nodeStatsMetricsResult.json.golden

@@ -1 +1 @@
-{"activeSearches":0,"breakers.estimatedSizeFieldDataCircuitBreakerInBytes":0,"breakers.estimatedSizeParentCircuitBreakerInBytes":0,"breakers.estimatedSizeRequestCircuitBreakerInBytes":0,"breakers.fieldDataCircuitBreakerTripped":0,"breakers.parentCircuitBreakerTripped":0,"breakers.requestCircuitBreakerTripped":0,"cache.cacheSizeIDInBytes":378599,"clusterName":"goTestCluster","displayName":"10.33.104.186","entityName":"node:10.33.104.186","event_type":"ElasticsearchNodeSample","flush.indexRefreshesTotal":0,"flush.indexRefreshesTotalInMilliseconds":0,"fs.bytesAvailableJVMInBytes":162707742720,"fs.bytesReadsInBytes":7904,"fs.iOOperations":235195,"fs.reads":99,"fs.totalSizeInBytes":164705353728,"fs.unallocatedBytesInBYtes":162707742720,"fs.writesInBytes":235096,"get.currentRequestsRunning":0,"get.requestsDcoumentExists":0,"get.requestsDcoumentMissing":0,"get.requestsDocumentExistsInMilliseconds":0,"get.requestsDocumentMissingInMilliseconds":0,"get.timeGetRequestsInMilliseconds":0,"get.totalGetRequests":0,"http.currentOpenConnections":2,"http.openedConnections":147,"indexing.docsCurrentlyDeleted":0,"indexing.documentsCurrentlyIndexing":0,"indexing.documentsIndexed":0,"indexing.timeDeletingDocumentsInMilliseconds":0,"indexing.timeIndexingDocumentsInMilliseconds":0,"indexing.totalDocumentsDeleted":0,"indices.indexingOperationsFailed":0,"indices.indexingWaitedThrottlingInMilliseconds":0,"indices.memoryQueryCacheInBytes":0,"indices.numberIndices":0,"indices.queryCacheEvictions":0,"indices.queryCacheHits":0,"indices.queryCacheMisses":0,"indices.recoveryOngoingShardSource":0,"indices.recoveryOngoingShardTarget":0,"indices.recoveryWaitedThrottlingInMilliseconds":0,"indices.requestCacheEvictions":0,"indices.requestCacheHits":0,"indices.requestCacheMemoryInBytes":0,"indices.requestCacheMisses":0,"indices.segmentsIndexShard":0,"indices.segmentsMaxMemoryIndexWriterInBytes":7423798234978,"indices.segmentsMemoryUsedDocValuesInBytes":0,"indices.segmentsMemoryUsedFixedBitSetInBytes":0,"indices.segmentsMemoryUsedIndexSegmentsInBytes":0,"indices.segmentsMemoryUsedIndexWriterInBytes":0,"indices.segmentsMemoryUsedNormsInBytes":0,"indices.segmentsMemoryUsedSegmentVersionMapInBytes":0,"indices.segmentsMemoryUsedStoredFieldsInBytes":0,"indices.segmentsMemoryUsedTermVectorsInBytes":0,"indices.segmentsMemoryUsedTermsInBytes":0,"indices.translogOperations":0,"indices.translogOperationsInBytes":0,"jvm.ThreadsActive":55,"jvm.ThreadsPeak":56,"jvm.gc.collections":100,"jvm.gc.collectionsInMilliseconds":100,"jvm.gc.concurrentMarkSweep":50,"jvm.gc.concurrentMarkSweepInMilliseconds":7238,"jvm.gc.majorCollectionsOldGenerationObjects":2,"jvm.gc.majorCollectionsOldGenerationObjectsInMilliseconds":128,"jvm.gc.majorCollectionsYoungGenerationObjects":108,"jvm.gc.majorCollectionsYoungGenerationObjectsInMilliseconds":1752,"jvm.gc.parallelNewCollections":2189,"jvm.gc.parallelNewCollectionsInMilliseconds":329,"jvm.mem.heapCommittedInBytes":1056309248,"jvm.mem.heapMaxInBytes":1056309248,"jvm.mem.heapUsed":2983749827,"jvm.mem.heapUsedInBytes":225181888,"jvm.mem.maxOldGenerationHeapInBytes":899284992,"jvm.mem.maxSurvivorSpaceInBYtes":17432576,"jvm.mem.maxYoungGenerationHeapInBytes":139591680,"jvm.mem.nonHeapCommittedInBytes":108519424,"jvm.mem.nonHeapUsedInBytes":100466784,"jvm.mem.usedOldGenerationHeapInBytes":127243224,"jvm.mem.usedSurvivorSpaceInBytes":94752,"jvm.mem.usedYoungGenerationHeapInBytes":97843912,"merges.currentActive":0,"merges.docsSegmentMerges":0,"merges.docsSegmentsMerging":0,"merges.mergedSegmentsInBytes":0,"merges.segmentMerges":0,"merges.sizeSegmentsMergingInBytes":0,"merges.totalSegmentMergingInMilliseconds":0,"node.hostname":"10.33.104.186","node.ipAddress":"10.33.104.186:9300","openFD":213,"queriesTotal":0,"refresh.total":0,"refresh.totalInMilliseconds":0,"searchFetchCurrentlyRunning":0,"searchFetches":0,"sizeStoreInBytes":0,"threadpool.bulk.Aueue":234,"threadpool.bulkActive":3,"threadpool.bulkRejected":2,"threadpool.bulkThreads":23,"threadpool.fetchShardStartedQueue":0,"threadpool.fetchShardStartedRejected":0,"threadpool.fetchShardStartedThreads":0,"threadpool.fetchShardStoreActive":0,"threadpool.fetchShardStoreQueue":0,"threadpool.fetchShardStoreRejected":0,"threadpool.fetchShardStoreThreads":0,"threadpool.flushActive":0,"threadpool.flushQueue":0,"threadpool.flushRejected":0,"threadpool.flushThreads":0,"threadpool.forceMergeActive":0,"threadpool.forceMergeQueue":0,"threadpool.forceMergeRejected":0,"threadpool.forceMergeThreads":0,"threadpool.genericActive":0,"threadpool.genericQueue":0,"threadpool.genericRejected":0,"threadpool.genericThreads":5,"threadpool.getActive":0,"threadpool.getQueue":0,"threadpool.getRejected":0,"threadpool.getThreads":0,"threadpool.indexActive":0,"threadpool.indexQueue":0,"threadpool.indexRejected":0,"threadpool.indexThreads":0,"threadpool.listenerActive":0,"threadpool.listenerQueue":0,"threadpool.listenerRejected":0,"threadpool.listenerThreads":0,"threadpool.managementActive":1,"threadpool.managementQueue":0,"threadpool.managementRejected":0,"threadpool.managementThreads":3,"threadpool.mergeActive":3,"threadpool.mergeQueue":39,"threadpool.mergeRejected":837,"threadpool.mergeThreads":9,"threadpool.percolateActive":8,"threadpool.percolateQueue":78,"threadpool.percolateRejected":8,"threadpool.percolateThreads":9,"threadpool.refreshActive":0,"threadpool.refreshQueue":0,"threadpool.refreshRejected":0,"threadpool.refreshThreads":0,"threadpool.searchActive":0,"threadpool.searchQueue":0,"threadpool.searchRejected":0,"threadpool.searchThreads":0,"threadpool.snapshotActive":0,"threadpool.snapshotQueue":0,"threadpool.snapshotRejected":0,"threadpool.snapshotThreads":0,"threadpoolActivefetchShardStarted":0,"transport.connectionsOpened":0,"transport.packetsReceived":20,"transport.packetsReceivedInBytes":11691,"transport.packetsSent":20,"transport.packetsSentInBytes":11691}
+{"activeSearches":0,"breakers.estimatedSizeFieldDataCircuitBreakerInBytes":0,"breakers.estimatedSizeParentCircuitBreakerInBytes":0,"breakers.estimatedSizeRequestCircuitBreakerInBytes":0,"breakers.fieldDataCircuitBreakerTripped":0,"breakers.parentCircuitBreakerTripped":0,"breakers.requestCircuitBreakerTripped":0,"cache.cacheSizeIDInBytes":378599,"clusterName":"goTestCluster","displayName":"10.33.104.186","entityName":"node:10.33.104.186","event_type":"ElasticsearchNodeSample","flush.indexRefreshesTotal":0,"flush.indexRefreshesTotalInMilliseconds":0,"fs.bytesAvailableJVMInBytes":162707742720,"fs.bytesReadsInBytes":7904,"fs.iOOperations":235195,"fs.reads":99,"fs.totalSizeInBytes":164705353728,"fs.unallocatedBytesInBYtes":162707742720,"fs.writesInBytes":235096,"get.currentRequestsRunning":0,"get.requestsDcoumentExists":0,"get.requestsDcoumentMissing":0,"get.requestsDocumentExistsInMilliseconds":0,"get.requestsDocumentMissingInMilliseconds":0,"get.timeGetRequestsInMilliseconds":0,"get.totalGetRequests":0,"http.currentOpenConnections":2,"http.openedConnections":147,"indexing.docsCurrentlyDeleted":0,"indexing.documentsCurrentlyIndexing":0,"indexing.documentsIndexed":0,"indexing.timeDeletingDocumentsInMilliseconds":0,"indexing.timeIndexingDocumentsInMilliseconds":0,"indexing.totalDocumentsDeleted":0,"indices.indexingOperationsFailed":0,"indices.indexingWaitedThrottlingInMilliseconds":0,"indices.memoryQueryCacheInBytes":0,"indices.numberIndices":0,"indices.queryCacheEvictions":0,"indices.queryCacheHits":0,"indices.queryCacheMisses":0,"indices.recoveryOngoingShardSource":0,"indices.recoveryOngoingShardTarget":0,"indices.recoveryWaitedThrottlingInMilliseconds":0,"indices.requestCacheEvictions":0,"indices.requestCacheHits":0,"indices.requestCacheMemoryInBytes":0,"indices.requestCacheMisses":0,"indices.segmentsIndexShard":0,"indices.segmentsMaxMemoryIndexWriterInBytes":7423798234978,"indices.segmentsMemoryUsedDocValuesInBytes":0,"indices.segmentsMemoryUsedFixedBitSetInBytes":0,"indices.segmentsMemoryUsedIndexSegmentsInBytes":0,"indices.segmentsMemoryUsedIndexWriterInBytes":0,"indices.segmentsMemoryUsedNormsInBytes":0,"indices.segmentsMemoryUsedSegmentVersionMapInBytes":0,"indices.segmentsMemoryUsedStoredFieldsInBytes":0,"indices.segmentsMemoryUsedTermVectorsInBytes":0,"indices.segmentsMemoryUsedTermsInBytes":0,"indices.translogOperations":0,"indices.translogOperationsInBytes":0,"jvm.ThreadsActive":55,"jvm.ThreadsPeak":56,"jvm.gc.collections":100,"jvm.gc.collectionsInMilliseconds":100,"jvm.gc.concurrentMarkSweep":50,"jvm.gc.concurrentMarkSweepInMilliseconds":7238,"jvm.gc.majorCollectionsOldGenerationObjects":2,"jvm.gc.majorCollectionsOldGenerationObjectsInMilliseconds":128,"jvm.gc.minorCollectionsYoungGenerationObjects":108,"jvm.gc.minorCollectionsYoungGenerationObjectsInMilliseconds":1752,"jvm.gc.parallelNewCollections":2189,"jvm.gc.parallelNewCollectionsInMilliseconds":329,"jvm.mem.heapCommittedInBytes":1056309248,"jvm.mem.heapMaxInBytes":1056309248,"jvm.mem.heapUsed":21,"jvm.mem.heapUsedInBytes":225181888,"jvm.mem.maxOldGenerationHeapInBytes":899284992,"jvm.mem.maxSurvivorSpaceInBYtes":17432576,"jvm.mem.maxYoungGenerationHeapInBytes":139591680,"jvm.mem.nonHeapCommittedInBytes":108519424,"jvm.mem.nonHeapUsedInBytes":100466784,"jvm.mem.usedOldGenerationHeapInBytes":127243224,"jvm.mem.usedSurvivorSpaceInBytes":94752,"jvm.mem.usedYoungGenerationHeapInBytes":97843912,"merges.currentActive":0,"merges.docsSegmentMerges":0,"merges.docsSegmentsMerging":0,"merges.mergedSegmentsInBytes":0,"merges.segmentMerges":0,"merges.sizeSegmentsMergingInBytes":0,"merges.totalSegmentMergingInMilliseconds":0,"node.hostname":"10.33.104.186","node.ipAddress":"10.33.104.186:9300","openFD":213,"queriesTotal":0,"refresh.total":0,"refresh.totalInMilliseconds":0,"searchFetchCurrentlyRunning":0,"searchFetches":0,"sizeStoreInBytes":0,"threadpool.activeFetchShardStarted":0,"threadpool.bulk.Aueue":234,"threadpool.bulkActive":3,"threadpool.bulkRejected":2,"threadpool.bulkThreads":23,"threadpool.fetchShardStartedQueue":0,"threadpool.fetchShardStartedRejected":0,"threadpool.fetchShardStartedThreads":0,"threadpool.fetchShardStoreActive":0,"threadpool.fetchShardStoreQueue":0,"threadpool.fetchShardStoreRejected":0,"threadpool.fetchShardStoreThreads":0,"threadpool.flushActive":0,"threadpool.flushQueue":0,"threadpool.flushRejected":0,"threadpool.flushThreads":0,"threadpool.forceMergeActive":0,"threadpool.forceMergeQueue":0,"threadpool.forceMergeRejected":0,"threadpool.forceMergeThreads":0,"threadpool.genericActive":0,"threadpool.genericQueue":0,"threadpool.genericRejected":0,"threadpool.genericThreads":5,"threadpool.getActive":0,"threadpool.getQueue":0,"threadpool.getRejected":0,"threadpool.getThreads":0,"threadpool.indexActive":0,"threadpool.indexQueue":0,"threadpool.indexRejected":0,"threadpool.indexThreads":0,"threadpool.listenerActive":0,"threadpool.listenerQueue":0,"threadpool.listenerRejected":0,"threadpool.listenerThreads":0,"threadpool.managementActive":1,"threadpool.managementQueue":0,"threadpool.managementRejected":0,"threadpool.managementThreads":3,"threadpool.mergeActive":3,"threadpool.mergeQueue":39,"threadpool.mergeRejected":837,"threadpool.mergeThreads":9,"threadpool.percolateActive":8,"threadpool.percolateQueue":78,"threadpool.percolateRejected":8,"threadpool.percolateThreads":9,"threadpool.refreshActive":0,"threadpool.refreshQueue":0,"threadpool.refreshRejected":0,"threadpool.refreshThreads":0,"threadpool.searchActive":0,"threadpool.searchQueue":0,"threadpool.searchRejected":0,"threadpool.searchThreads":0,"threadpool.snapshotActive":0,"threadpool.snapshotQueue":0,"threadpool.snapshotRejected":0,"threadpool.snapshotThreads":0,"transport.connectionsOpened":0,"transport.packetsReceived":20,"transport.packetsReceivedInBytes":11691,"transport.packetsSent":20,"transport.packetsSentInBytes":11691}