Refactor out non API code about accumulo-examples HOT 17 CLOSED

I was looking into this issue and after removing the exceptions and rebuilding/retesting I didn't notice any errors or changes. Can you elaborate on what you mean with this issue and if there is anything in addition that must be done or anything that I am missing? Thanks!

from accumulo-examples.

@Manno15 try buliding the project with "mvn clean install" or "mvn clean verify".

from accumulo-examples.

I just updated the build script to call verify and make sure it passes all the checks. So if you pull down the update and run ./bin/build it should run checkstyle as well.

from accumulo-examples.

Thanks, I will run it now and see what happens.

from accumulo-examples.

Is the goal to change how the import control works so we don't need those exceptions or to change where they are used so we do not need the imports? Just a little confusion on wording. Thanks!

from accumulo-examples.

to change where they are used so we do not need the imports?

Yes. Change the code that uses these imports so we can remove the exceptions from the import-control file.

from accumulo-examples.

@Manno15 The intention here is to provide examples that a user could reasonably expect to write and use. However, we're currently doing things in these examples that are not recommended for users... like using internal-only unstable APIs. These aren't stable, and this practice makes for bad examples.

The intent of this ticket is to migrate those "bad" code examples away from using Accumulo internal classes (represented by the imported classes that we'd prefer to ban). This may mean getting rid of bad examples entirely... or it may mean rewriting them or simplifying them to avoid importing internal/unstable code from Accumulo's internals.

from accumulo-examples.

Okay, that makes a lot of sense. Thank you both for clarifying for me.

from accumulo-examples.

Considering that the Trace Dump is not under the listed examples, would that be one where we would get rid of entirely? Only thing the exception blocks is the actual printing of the trace.

from accumulo-examples.

Considering that the Trace Dump is not under the listed examples, would that be one where we would get rid of entirely? Only thing the exception blocks is the actual printing of the trace.

We have plans to remove the Tracer (eventually) from Accumulo so perhaps leave that one for now. I am not sure if the Tracer will be deleted or moved to its own repository. @ctubbsii knows more about the Tracer so maybe he can weight in on what to do with this example.

from accumulo-examples.

I am working on a different way to print it, similar to some of the other examples.

from accumulo-examples.

I'm not familiar with the trace example, but it was my intention to deprecate and/or remove the tracer (sink) service, and investigate updating the trace instrumentation we're using. A good trace example would use custom trace sink specifically for that example rather than rely on the tracer service or its storage back into Accumulo.

from accumulo-examples.

The one I was more talking about was the TraceDump example which seems to scan a table that then uses TraceDump to print Trace info and tserver info neatly. The tracing Example that is apart of the second exception on the list to remove still seems to work normally even with Distributed Trace removed. So I am not quite sure where to go for those two.

from accumulo-examples.

TraceDump is part of the tracer sink service we provide (trace.span.receivers = org.apache.accumulo.tracer.ZooTraceClient) which receives spans and stores them back into an Accumulo table. TraceDump is not public API (no part of the tracer service is), but was presumably written as a utility to view and verify the data that has been received and stored by that tracer service.

The example should either be removed, or modified to set a different span receiver that is more suitable for an example. If it's difficult to remove, I would just move on to the others for now. There's no urgency to that.

from accumulo-examples.

The example itself isn't directly tied to anything so it shouldn't be hard to remove. I can take a look at modifying it to set a different span receiver after I finish going through the rest if that is more preferable.

from accumulo-examples.

@Manno15 Don't feel like this needs to all be fixed in a single pass. The use of internal, non-public APIs, in the examples can be fixed incrementally. 😺

from accumulo-examples.

I will keep that in mind. Thanks!

from accumulo-examples.