docs: update onboarding steps for Go v3 client

[karel-rehor]

Updates the onboarding steps for Go v3 client

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

[bednar]

From my point of view, this looks good, and along with the new API for the client. Great job! 👍

[karel-rehor]

I've decided to go ahead with changes only to GO and will update Java onboarding in another branch. I'd rather we get this part of the UI updated ASAP instead of possibly having it held until January because of 1) Christmas Holidays 2) Unexpected obstacles in updating onboarding for Java.

BTW. Not sure what to do about the monitor-ci-tests and remocal. It seems there is an issue in the underlying system deployment apparently unrelated to these changes.

https://output.circle-artifacts.com/output/job/322ce1ff-e9f2-4414-9ebc-59ed3049eddd/artifacts/0/tests/e2e-remocal/e2e-test-remocal-deploy.log

Time limit has been exceeded. Giving up! Listing status of all pods:

NAME                                                              READY   STATUS             RESTARTS        AGE
annotationd-7b48589d76-n9g4w                                      1/1     Running            1 (8m7s ago)    8m8s
...
gateway-external-meta-595c495797-lw6fr                            0/1     CrashLoopBackOff   6 (107s ago)    8m10s
gateway-external-write-bbc4f748b-x9sj8                            0/1     CrashLoopBackOff   6 (107s ago)    8m11s
gateway-internal-meta-7584495fbf-8dclw                            0/1     CrashLoopBackOff   6 (110s ago)    8m10s
gateway-internal-write-744cf85dc8-89fdh                           0/1     CrashLoopBackOff   6 (2m1s ago)    8m11s
...
redpanda-0                                                        0/1     ImagePullBackOff   0               8m48s
...
storage-0                                                         0/1     CrashLoopBackOff   6 (2m14s ago)   8m11s
storage-1                                                         0/1     CrashLoopBackOff   6 (101s ago)    8m7s
...
Gathering ingress logs
Creating archive

[david-rusnak]

Hi @karel-rehor, sorry for the delay on this - I was working on fixing the CI pipeline and I see it has passed the tests now. I'll take a look at this PR in more detail tomorrow. Thank you!

[david-rusnak]

Hello! Thanks for doing this! I apologize for not getting to this when I said I would, it slipped my mind completely. Similar to the Java onboarding, it would be helpful for a video demonstrating the changes since I noticed some spacing and formatting changes, but it looks good to me otherwise! If the video size limit is an issue here, let me know and I can run the branch locally to see these changes

[david-rusnak]

I see the // FOO line is the only thing changed here, is that for consistency?

[karel-rehor]

This was removed

[david-rusnak]

Curious to see what effect this whitespace has on the snippet

[karel-rehor]

The instruction is to add this snippet at the end of the main() function in a previous snippet. All together this renders as...

func main() {
    // Create client
    url := "http://localhost:8080"
    token := os.Getenv("INFLUXDB_TOKEN")

    // Create a new client using an InfluxDB server base URL and an authentication token
    client, err := influxdb3.New(influxdb3.ClientConfig{
      Host:  url,
      Token: token,
    })

    if err != nil {
      panic(err)
    }
    // Close client at the end and escalate error if present
    defer func (client *influxdb3.Client)  {
      err := client.Close()
      if err != nil {
        panic(err)
      }
    }(client)

    database := "my-bucket"
    data := map[string]map[string]interface{}{
    "point1": {
      "location": "Klamath",
      "species":  "bees",
      "count":    23,
    },
    "point2": {
      "location": "Portland",
      "species":  "ants",
      "count":    30,
    },
    "point3": {
      "location": "Klamath",
      "species":  "bees",
      "count":    28,
    },
    "point4": {
      "location": "Portland",
      "species":  "ants",
      "count":    32,
    },
    "point5": {
      "location": "Klamath",
      "species":  "bees",
      "count":    29,
    },
    "point6": {
      "location": "Portland",
      "species":  "ants",
      "count":    40,
    },
  }

  // convert data to Points
  points := []*influxdb3.Point{}
  // start time stamp
  stamp := time.Now().Add(time.Duration(len(data)) * time.Second * -1)

  for key := range data {
	  points = append(points,
		  influxdb3.NewPointWithMeasurement("census").
			  SetTag("location", data[key]["location"].(string)).
			  SetIntegerField(data[key]["species"].(string),
				  int64(data[key]["count"].(int))).
			  SetTimestamp(stamp))
	  stamp = stamp.Add(time.Second) // Add a second to the stamp
  }

  // Write data
  fmt.Printf("Writing %d points\n", len(points))  
  if err := client.WritePoints(context.Background(),
	  points,
	  influxdb3.WithDatabase(database)); err != nil {
	    panic(err)
  }
    
}

[david-rusnak]

Also curious about the whitespace here, looks like the number of spaces in a tab has changed, is that maintained across all snippets in the go onboarding?

[karel-rehor]

Here is the main() method with all copy-pasted snippets.

func main() {
    // Create client
    url := "http://localhost:8080"
    token := os.Getenv("INFLUXDB_TOKEN")

    // Create a new client using an InfluxDB server base URL and an authentication token
    client, err := influxdb3.New(influxdb3.ClientConfig{
      Host:  url,
      Token: token,
    })

    if err != nil {
      panic(err)
    }
    // Close client at the end and escalate error if present
    defer func (client *influxdb3.Client)  {
      err := client.Close()
      if err != nil {
        panic(err)
      }
    }(client)

    database := "my-bucket"
    data := map[string]map[string]interface{}{
    "point1": {
      "location": "Klamath",
      "species":  "bees",
      "count":    23,
    },
    "point2": {
      "location": "Portland",
      "species":  "ants",
      "count":    30,
    },
    "point3": {
      "location": "Klamath",
      "species":  "bees",
      "count":    28,
    },
    "point4": {
      "location": "Portland",
      "species":  "ants",
      "count":    32,
    },
    "point5": {
      "location": "Klamath",
      "species":  "bees",
      "count":    29,
    },
    "point6": {
      "location": "Portland",
      "species":  "ants",
      "count":    40,
    },
  }

  // convert data to Points
  points := []*influxdb3.Point{}
  // start time stamp
  stamp := time.Now().Add(time.Duration(len(data)) * time.Second * -1)

  for key := range data {
	  points = append(points,
		  influxdb3.NewPointWithMeasurement("census").
			  SetTag("location", data[key]["location"].(string)).
			  SetIntegerField(data[key]["species"].(string),
				  int64(data[key]["count"].(int))).
			  SetTimestamp(stamp))
	  stamp = stamp.Add(time.Second) // Add a second to the stamp
  }

  // Write data
  fmt.Printf("Writing %d points\n", len(points))  
  if err := client.WritePoints(context.Background(),
	  points,
	  influxdb3.WithDatabase(database)); err != nil {
	    panic(err)
  }
  
  // Execute query with parameters
  query := `SELECT *
   FROM 'census'
   WHERE time >= now() - interval '1 hour'
   AND ($species1 IS NOT NULL OR $species2 IS NOT NULL)`

  iterator, err := client.QueryWithParameters(context.Background(),
	  query, influxdb3.QueryParameters{
		  "species1": "bees",
		  "species2": "ants",
	  },
	  influxdb3.WithDatabase(database))

  if err != nil {
	  panic(err)
  }

  val2int := func(v interface{}) int64 {
	  if v == nil {
		  return 0
	  }
	  return v.(int64)
  }
	
  for iterator.Next() {
	  value := iterator.Value()

	  location := value["location"]
	  ants := val2int(value["ants"])
	  bees := val2int(value["bees"])
	  ts := value["time"].(time.Time)
	  fmt.Printf("At %s in %s there were %d ants and %d bees\n", 
	    ts.Format(time.RFC3339), location, ants, bees)
  }
  
    
}

[wdoconnell]

Hi @karel-rehor - thanks for doing this. This looks good based on my review, as long as the rationale for doing this is the same as in the Go PR: i.e., this is just to update to conform to changes to the influxdb v3 client libraries.

Before we approve this to merge in, could you please add a video confirming we don't end up with any visual artifacts here? Thanks very much.

[karel-rehor]

Here is a screen cast of the workflow for this on-boarding update. Not shown is pasting code samples to an IDE, or waiting for response after running writes.

Screencast.from.30-01-25.13.58.10.webm

[wdoconnell]

This looks good to me now - thanks for posting the video. I noted here #6994 that we need to wait for a moment on an internal fix to our CI pipeline - I will ping you once it has been cleared up.

[wdoconnell]

Hi @karel-rehor - you should be able to rebase / repush and attempt to merge now.

[wdoconnell]

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

[karel-rehor]

@wdoconnell
I've attempted the rebase and push with force, but now that I'm controlling the results locally with yarn start:dev I'm not seeing the contents of the file homepageExperience/components/steps/go/WriteDataSql.tsx but instead the contents of homepageExperience/components/steps/go/WriteData.tsx. In the IDE I still see the changes I made to WriteDataSql.tsx, but I'm not sure what has changed, that they are not showing up in the dev deployment. I was expecting this to take at most an hour and I have some other more pressing priorities to deal with at the moment. So, I'll come back to this once those are solved.

[karel-rehor]

@wdconnell
OK, the issue on Wednesday was that I forgot to set the feature flag ioxOnboarding when reviewing the rebased branch. Once this is set, I see the changes for Iox in the SQL based onboarding steps.

If you could once more give this your review - I removed a commented line in a code snippet caught by @david-rusnak - I think this can be merged.

[wdoconnell]

@karel-rehor - Looks good to merge, feel free to do so. Thank you for updating!

[wdoconnell]

More flake occurred. Going to retry this on Monday a.m., as it's late here. We should be able to pass CI as it was in good condition for #7000. I will give it a look first thing in the am.

[wdoconnell]

Getting flake on the scriptQueryBuilder test. We may need to revisit that if it keeps causing issues like this.

[wdoconnell]

@karel-rehor Looking at the cause of the e2e failure I think the interim solution will need to be disabling this flaking test. #7020. I have opened an internal issue to have someone allocate time to have a closer look at the root causes so that the relevant test can be re-enabled. You will need to rebase once #7020 is merged.

[wdoconnell]

@karel-rehor Looking at the cause of the e2e failure I think the interim solution will need to be disabling this flaking test. #7020. I have opened an internal issue to have someone allocate time to have a closer look at the root causes so that the relevant test can be re-enabled. You will need to rebase once #7020 is merged.

I have handled the rebase - will add it back to the merge queue now.