[HBASE-22823] Mark Canary as Public/Evolving

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Won't Fix
• Assignee: Caroline Zhou
• Reporter: Andrew Kyle Purtell
• Created: 08/Aug/19 20:29
• Updated: 03/Sep/19 16:44
• Resolved: 20/Aug/19 16:42

Description

Canary is marked as a Private class. Its interfaces could change at any time. Should we change the annotation on Canary to Public/Evolving? Or add annotations on some of these subtypes? I think it depends on how we think Canary results should be consumed.

In our production we find that scraping logs and parsing them is brittle and not scalable. Although the scalability issue is more to do with the totality of logs from a Hadoopish stack, if you run HBase then you have this problem, and you wouldn't be using the canary if you didn't run HBase. We have a tool that embeds the Canary and calls various methods and takes actions without needing a round trip to the logs and whatever aggregates them.

I propose we promote Canary to Public/Evolving.

Issue Links

• breaks: HBASE-22874 Define a public interface for Canary and move existing implementation to LimitedPrivate