ES Cluster Shards and Statistics

.gitignore

@@ -1,4 +1,11 @@
 cmd/escp/escp
 cmd/esdiff/esdiff
+cmd/esshards/esshards
+cmd/primeshards/primeshards
+cmd/shardsize/shardsize
+
+vendor/**/
 
 .*.swp
+
+

LICENSE

@@ -0,0 +1,202 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Lytics
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

README.md

@@ -27,6 +27,15 @@ esdiff -d 4 http://host1:9200/ srcindex http://host2:9200 dstindex
 esdiff -d 1 http://host1:9200/ srcindex http://host2:9200 dstindex
 ```
 
+## Introspection tools
+
+* `primeshards` Correlates which indexes which have one or more primary shards on a subset of Elasticsearch nodes.
+* `shardsize`   Returns a list of indexes whose shards are larger than 10GB. 
+
+### Disclaimer
+
+This toolkit has been built against Elasticsearch 2.3.2. Your mileage may very on differing versions.
+
 Other Tools
 -------------------------------
 * https://github.com/taskrabbit/elasticsearch-dump

cmd/primeshards/README.md

@@ -0,0 +1,17 @@
+
+
+> primeshards
+Correlates which indexes which have one or more primary shards on a subset of Elasticsearch nodes.
+
+Useful for narrowing down hot indexes and their subsequent shards by host.
+If a single primary shard is allocated on one of the given nodes, the index is added to the index list returned.
+
+Usage: see -help
+
+
+
+
+
+
+- - -
+Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)

cmd/primeshards/main.go

@@ -0,0 +1,54 @@
+// Correlates which indexes which have one or more primary shards on a subset of Elasticsearch nodes.
+//
+// Useful for narrowing down hot indexes and their subsequent shards by host.
+// If a single primary shard is allocated on one of the given nodes, the index is added to the index list returned.
+//
+// Usage: see -help
+package main
+
+import (
+	"flag"
+	"sort"
+	"strings"
+
+	log "github.com/Sirupsen/logrus"
+	"github.com/lytics/escp/esshards"
+)
+
+func main() {
+	var hostAddr string
+	var nodes []string
+	var nodesRaw string
+	log.SetLevel(log.InfoLevel)
+
+	flag.StringVar(&nodesRaw, "nodes", "", "Nodes to find common primary shards eg: \"es1,es2,es3\"")
+	flag.StringVar(&hostAddr, "host", "http://localhost:9200/", "Elasticsearch query address")
+	flag.Parse()
+
+	log.Debugf("nodesRaw: %v", nodesRaw)
+	nodes = strings.Split(nodesRaw, ",")
+
+	shardAddr := hostAddr + "_search_shards"
+	info, err := esshards.Get(shardAddr)
+	if err != nil {
+		log.Fatalf("Error querying shard info from Elasticsearch:\n%#v", err)
+	}
+
+	HRnodeSet := make(map[string]struct{})
+	for _, v := range nodes {
+		HRnodeSet[v] = struct{}{}
+	}
+	nodeIDs := esshards.NodesFromHRName(*info, HRnodeSet)
+	log.Debugf("Nodes associated: %#v", nodeIDs)
+
+	cmi := esshards.CommonPrimaryIndexes(info, nodeIDs)
+	log.Infof("Indices with primary shards common to %v:\n", nodeIDs)
+	indexes := make([]string, 0)
+	for k, _ := range cmi {
+		indexes = append(indexes, k)
+	}
+	sort.Strings(indexes)
+	for _, v := range indexes {
+		log.Infof("%s", v)
+	}
+}

cmd/shardsize/README.md

@@ -0,0 +1,19 @@
+
+
+> shardsize
+Returns a list of indexes whose shards are larger than 10GB.
+
+Large shard sizes can be problematic in elasticsearch. There is no clear optimal shard size; it is mostly arbitrated by your data structures.
+
+`cmd/shardsize` calculates which indicies have excessively large shards and prints them to stdout.
+
+#### eg
+`./shardsize --host=<a href="http://localhost:9200">http://localhost:9200</a>`
+
+
+
+
+
+
+- - -
+Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)

cmd/shardsize/main.go

@@ -0,0 +1,70 @@
+// Returns a list of indexes whose shards are larger than 10GB.
+//
+// Large shard sizes can be problematic in elasticsearch. There is no clear optimal shard size; it is mostly arbitrated by your data structures.
+//
+// `cmd/shardsize` calculates which indicies have excessively large shards and prints them to stdout.
+//
+// #### eg
+// `./shardsize --host=http://localhost:9200`
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"sort"
+
+	log "github.com/Sirupsen/logrus"
+	"github.com/lytics/escp/esshards"
+	"github.com/lytics/escp/esstats"
+	"github.com/lytics/escp/estypes"
+	"github.com/pivotal-golang/bytefmt"
+)
+
+func main() {
+	var hostAddr string
+	log.SetLevel(log.InfoLevel)
+
+	flag.Usage = func() {
+		fmt.Fprintf(os.Stderr, "Usage: %s -host http://localhost:9200/\n", os.Args[0])
+		flag.PrintDefaults()
+	}
+
+	flag.StringVar(&hostAddr, "host", "http://localhost:9200/", "Elasticsearch query address")
+	flag.Parse()
+
+	shardAddr := hostAddr + "_stats"
+	stats, err := esstats.Get(shardAddr)
+	if err != nil {
+		log.Fatalf("Error querying shard info from Elasticsearch:\n%#v", err)
+	}
+
+	indices := make(map[string]estypes.IndexInfo)
+	for k, v := range stats.Indices {
+		indices[k] = estypes.IndexInfo{Name: k, ByteSize: v.Primaries.Store.IndexByteSize}
+	}
+
+	shardInfo, err := esshards.Get(hostAddr + "_search_shards")
+	if err != nil {
+		log.Fatalf("Error querying shard info from Elasticsearch:\n%#v", err)
+	}
+
+	shardCount := esstats.CountShards(shardInfo.Shards)
+
+	indexList := make([]estypes.IndexInfo, 0)
+	for k, v := range shardCount {
+		ii := indices[k]
+		ii.ShardCount = v
+		ii.CalculateShards()
+		indices[k] = ii
+		indexList = append(indexList, ii)
+	}
+
+	sort.Sort(estypes.IndexSort(indexList))
+	log.Infof("         Index         IndexSize  ShardSize  Shards (Optimal Shards)")
+	for _, sc := range indexList {
+		if sc.OptimalShards-sc.ShardCount > 10 {
+			log.Infof("%20s: %7s %12s    %3d %8d", sc.Name, bytefmt.ByteSize(uint64(sc.ByteSize)), bytefmt.ByteSize(uint64(sc.BytesPerShard)), sc.ShardCount, sc.OptimalShards)
+		}
+	}
+}

esshards/doc.go

@@ -0,0 +1,2 @@
+// ES Shards package encapsulates functionality to understand your Elasticsearch cluster's shard allocation.
+package esshards