docs: update onboarding steps for Java v3 client by karel-rehor · Pull Request #6994 · influxdata/ui

karel-rehor · 2025-01-07T09:26:13Z

Updates the onboarding steps for the Java v3 client.
Introduces new library features.

Query parameters
Up to date Write API

Checklist

Authors and Reviewer(s), please verify the following:

A PR description, regardless of the triviality of this change, that communicates the value of this PR
Well-formatted conventional commit messages that provide context into the change
Documentation updated or issue created (provide link to issue/PR)
Signed CLA (if not already signed)
Feature flagged, if applicable

wdoconnell

Hi @karel-rehor - thank you, I had a few observations here:

This variant of the onboarding flow is behind the ioxOnboarding feature flag, so it won't be shown for any users with that flag disabled; the Flux onboarding will otherwise be shown. That flag is enabled generally, but I will check with others if that is the right approach here.
This makes the Java onboarding examples a good amount longer - I am not sure if that is desirable unless this is also intended as a bug fix or for some other purpose. Can you speak to the motivation behind the work?
Not absolutely necessary in all cases, but for a PR like this that has visual impact on the flow, I usually find it is helpful for the review to include a video illustrating what was changed.

wdoconnell · 2025-01-07T14:32:16Z

src/homepageExperience/components/steps/java/ExecuteQuerySql.tsx

+  const query = `            String sql = "SELECT * " +
+              "FROM 'census' " +
+              "WHERE time >= now() - interval '5 minutes' " +
+              "AND ('$species1' IS NOT NULL OR '$species2' IS NOT NULL) order by time asc";


Are we updating this query due to a failure with the test dataset, or is this simply designed to illustrate a different principle?

Query parameters are a feature added in the 0.6.0 client library release from March of last year.

The text above the snippet briefly introduces them: "The following code replaces the fixed values of "bees" and "ants" with the parameters $species1 and $species2."

We thought users would like to be made aware of this feature. A number of users requested it and are now using it.

wdoconnell · 2025-01-07T14:33:55Z

src/homepageExperience/components/steps/java/ExecuteQuerySql.tsx

+      <p>
+        The query transport makes use of Apache Arrow Flight to shorten
+        processing time. When executing queries Arrow needs access to internal
+        JVM resources. This means setting the following JVM argument:{' '}


I might correct "means" to "This requires setting the following JVM argument"

wdoconnell · 2025-01-07T14:34:51Z

src/homepageExperience/components/steps/java/ExecuteQuerySql.tsx

+      </p>
+      <h2>Java</h2>
+      <p>
+        With straightforward Java this can be done with an environment variable:


I don't think we should qualify whether the script is 'straightforward' since it should speak for itself -- "This can be done with an environment variable" should be enough.

wdoconnell · 2025-01-07T15:25:37Z

Remocal failure in CI looks transient, so I am re-running the tests.

karel-rehor · 2025-01-08T09:42:55Z

Hi @wdoconnell

This variant of the onboarding flow is behind the ioxOnboarding feature flag, so it won't be shown for any users with that flag disabled; the Flux onboarding will otherwise be shown. That flag is enabled generally, but I will check with others if that is the right approach here.

My understanding is that we primarily want these changes visible to cloud users and in the cloud interface, which, if I understand correctly, should have ioxOnboarding enabled.

This makes the Java onboarding examples a good amount longer - I am not sure if that is desirable unless this is also intended as a bug fix or for some other purpose. Can you speak to the motivation behind the work?

The influxdb3 client libraries have evolved considerably since these onboarding steps were first written. Since the beginning of December client libraries are progressively being released to the first major version 1.0 (and in the case of go 2.0) because of breaking changes. The new onboarding steps illustrate the following features added in the past last year:

Query parameters
Arrow flight support for queries
Handling of null/nil values
Leveraging Arrow metadata during deserialization

I also though it would be helpful to organize test data into a POJO as it is a common Java idiom,

Not absolutely necessary in all cases, but for a PR like this that has visual impact on the flow, I usually find it is helpful for the review to include a video illustrating what was changed.

OK, I thought that I would need to take time to compress the screencast file, as in the past I had encountered a 10MB limit, but it seems this can be added. This shows only the workflow without pasting snippets to an IDE.

Screencast.from.08-01-25.10.57.08.webm

wdoconnell

@karel-rehor: This looks good now. Thanks for your revisions, and sorry that it took me a bit to get back to another review.

With respect to this point:

This variant of the onboarding flow is behind the ioxOnboarding feature flag, so it won't be shown for any users with that flag disabled; the Flux onboarding will otherwise be shown. That flag is enabled generally, but I will check with others if that is the right approach here.

I think it's actually undesirable to have this controlled by flag, as opposed to the isOrgIOx selector. I discussed this with Daniel, and either he or I will put up a PR making that adjustment.

wdoconnell · 2025-01-22T20:13:15Z

@karel-rehor Could you please re-run the pipeline for this? It looks like the past failure was flake. If not, please ping me and I'll diagnose the CI failure.

karel-rehor · 2025-01-30T13:25:22Z

@wdoconnell Hi, I've rerun the monitor-ci-tests and they are failing on the workflow dependency "remocal-smoke-test"

https://app.circleci.com/pipelines/github/influxdata/monitor-ci/21949/workflows/c6396b4f-1f22-44bb-a7d4-a1c4a461fc0f

and then

https://app.circleci.com/pipelines/github/influxdata/monitor-ci/21949/workflows/c6396b4f-1f22-44bb-a7d4-a1c4a461fc0f/jobs/1492029

In this job the step "install kubectl binary" is failing. It downloads the binary from (https://storage.googleapis.com/kubernetes-release/release/v1.15.0/bin/linux/amd64/kubectl) and then runs a sha256 check sum of the downloaded file. The download fails, (most likely because of an issue with locating certificates - see first line below) and the kubectl executable can then not be found on the system.

curl: (77) error setting certificate verify locations:  CAfile: /etc/ssl/certs/ca-certificates.crt CApath: /etc/ssl/certs
sha256sum: /usr/local/bin/kubectl: No such file or directory
/usr/local/bin/kubectl: FAILED open or read
sha256sum: WARNING: 1 listed file could not be read

Exited with code exit status 1

Unfortunately I don't have permissions to rerun this job with SSH to investigate further.

wdoconnell · 2025-02-03T21:02:41Z

Hi @karel-rehor - I traced this, and we have someone fixing this internally. Since this is public I am reserving the details for slack.

wdoconnell · 2025-02-19T23:16:49Z

Hi @karel-rehor : You should be good to rebase and proceed with trying to merge, as CI should be fixed.

wdoconnell · 2025-02-25T18:16:21Z

Hi @karel-rehor - checking in to see if you are good to rebase and merge this - thank you.

karel-rehor · 2025-02-28T13:16:57Z

@wdoconnell OK, This has been rebased. Do you want to rebase this or should I handle it?

wdoconnell · 2025-02-28T14:56:21Z

@wdoconnell OK, This has been rebased. Do you want to rebase this or should I handle it?

You're all set now @karel-rehor -- feel free to merge. I'll keep an eye out if CI fails, but it should be clear now.

wdoconnell · 2025-02-28T19:05:04Z

@karel-rehor Looks like transient flake to me - I am re-merging.

* docs: (WIP) updates onboarding steps for the influxdb3-java client. * chore: dry run onboarding java. Add missing semi-colon. Minor edit. * chore: run prettier:fix * docs: update wording of query requirements for Arrow. * chore: rerun linter * chore: retrigger checks

karel-rehor requested a review from bednar January 7, 2025 09:26

karel-rehor requested review from a team as code owners January 7, 2025 09:26

hansenreid requested a review from wdoconnell January 7, 2025 13:47

wdoconnell reviewed Jan 7, 2025

View reviewed changes

karel-rehor requested a review from wdoconnell January 9, 2025 09:21

wdoconnell approved these changes Jan 22, 2025

View reviewed changes

wdoconnell mentioned this pull request Feb 3, 2025

docs: update onboarding steps for Go v3 client #6987

Merged

5 tasks

karel-rehor added 6 commits February 28, 2025 13:37

docs: (WIP) updates onboarding steps for the influxdb3-java client.

1d39317

chore: dry run onboarding java. Add missing semi-colon. Minor edit.

e302e86

chore: run prettier:fix

92d0515

docs: update wording of query requirements for Arrow.

0825a7b

chore: rerun linter

3406ac8

chore: retrigger checks

7e83816

karel-rehor force-pushed the update-onboarding-java branch from 64572be to 7e83816 Compare February 28, 2025 12:38

karel-rehor added this pull request to the merge queue Feb 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 28, 2025

wdoconnell added this pull request to the merge queue Feb 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 28, 2025

wdoconnell added this pull request to the merge queue Feb 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 28, 2025

wdoconnell added this pull request to the merge queue Feb 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 28, 2025

wdoconnell added this pull request to the merge queue Mar 3, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 3, 2025

wdoconnell added this pull request to the merge queue Mar 3, 2025

Merged via the queue into master with commit 1ebee1c Mar 3, 2025
6 checks passed

wdoconnell deleted the update-onboarding-java branch March 3, 2025 18:59

Conversation

karel-rehor commented Jan 7, 2025

Checklist

Uh oh!

wdoconnell left a comment

Choose a reason for hiding this comment

Uh oh!

wdoconnell Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

karel-rehor Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

wdoconnell Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

karel-rehor Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

wdoconnell Jan 7, 2025

Choose a reason for hiding this comment

Uh oh!

karel-rehor Jan 8, 2025

Choose a reason for hiding this comment

Uh oh!

wdoconnell commented Jan 7, 2025

Uh oh!

karel-rehor commented Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wdoconnell left a comment

Choose a reason for hiding this comment

Uh oh!

wdoconnell commented Jan 22, 2025

Uh oh!

karel-rehor commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wdoconnell commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wdoconnell commented Feb 19, 2025

Uh oh!

wdoconnell commented Feb 25, 2025

Uh oh!

karel-rehor commented Feb 28, 2025

Uh oh!

wdoconnell commented Feb 28, 2025

Uh oh!

Uh oh!

wdoconnell commented Feb 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

karel-rehor commented Jan 8, 2025 •

edited

Loading

karel-rehor commented Jan 30, 2025 •

edited

Loading

wdoconnell commented Feb 3, 2025 •

edited

Loading