NatLabRockies / NatLabRockies/api-umbrella

Is it necessary to have monthly indexes?

Open
#369 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Description

When inspecting Elasticsearch indexes, I notice that API Umbrella is creating an index for every month:

screenshot_20170524_141518

The Elasticsearch documentation describes an index as:

a collection of documents that have somewhat similar characteristics.

Elasticsearch 2.0 Basic Concepts Index

Since the API Umbrella analytics documents do not change significantly in structure, what is the benefit of having monthly indexes?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating where API Umbrella creates its monthly Elasticsearch analytics indexes and reviewing how analytics documents are queried and retained. Determine whether the monthly partitioning has a documented operational or query benefit; done means an agreed explanation or a clearly scoped follow-up change.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch
Domain
analytics
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.