GettingStarted Rework

[TackAdam]

Description

Updates to GettingStarted

1. Restructure getting started to be Logs, Metrics, and Traces
2. Remove the dashboard creation
3. Change the workflow order to have Schema / Index Patterns (and create asset button)at the first steps before the user creates there index.
4. Get rid of the query and analyze panel and add them into the workflow.
5. If the integration exist (Currently only for Nginx) give an option to redirect to the integration panel to finish creating it.
6. Break apart the OTEL workflow into logs, metrics, and traces/services.
7. Remove the quickstart workflow and replace it with "Self Managed" and an additional tab for "AWS"(for OTEL logs/metrics/traces)
8. Add default behavior to open up OTEL Logs when landing on the page.
9. Remove workflow for file upload

Before	After

Video of new experience
https://github.com/user-attachments/assets/a8cc30d6-70a7-4d18-b8c3-6b7ffada0869

For Nginx

Redirect to

Issues Resolved

Check List

• New functionality includes testing.
  • All tests pass, including unit test, integration test and doctest
• New functionality has been documented.
  • New functionality has javadoc added
  • New functionality has user manual doc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[mengweieric]

where's the source of these json files, do we have to main all these files?

[TackAdam]

This link is not exposed to the user and was previously used to generate information on the dashboard we are not creating anymore.
We are currently manually making all these json's to provide the steps/workflows but would like to eventually move these to the catalog.

[mengweieric]

This link is not exposed to the user and was previously used to generate information on the dashboard we are not creating anymore.

We've spoke about this offline, this is not specifically for this info but overall like do we have to manually create/maintain these json files on the UI side.

We are currently manually making all these json's to provide the steps/workflows but would like to eventually move these to the catalog.

Could we create issue for this just for tracking purposes?

[mengweieric]

let's move this to constant file and add i18n

[TackAdam]

Added i18n

      <HeaderControlledComponentsWrapper
        description={i18n.translate('observabilityGetStarted.description', {
          defaultMessage: 'Get started with collecting and monitoring your observability data.',
        })}

I don't think it should be moved to constant folder as it is a 1 off description and currently all the top nav registration of descriptions are done in file.

[mengweieric]

thanks, generally we should for better maintainability but not a blocker

[mengweieric]

These styles should be moved to corresponding component scss file(s), here should only contain general import as this is the index file

[TackAdam]

The icon components are shared between integrations and getting-started to keep the image size consistent between the plugins.

[mengweieric]

you could reuse existing or create new shared scss files for general styings that are shared across different modules. index file here are for modularity importing of scss partials.

[mengweieric]

We may want to consider refactor this code piece as it is

• not easy to maintain, the growing number of cases makes these magic strings
  • proven to typos
  • not easy to be modified when naming and version changes along the way

we want to consider

• use map or enum for all these file names and move these stuff to constant file.

type TutorialId = 'otelLogs' | 'otelMetrics' | 'otelTraces' | 'nginx' | 'java' | 'python' | 'golang';

const assetMap: Record<TutorialId, string> = {
  otelLogs: 'otel-index-patterns-1.0.0-Logs.ndjson',
  otelMetrics: 'otel-index-patterns-1.0.0-Metrics.ndjson',
  otelTraces: 'otel-index-patterns-1.0.0-Traces.ndjson',
  nginx: 'nginx-1.0.0.ndjson',
  java: 'java-tutorial-1.0.0.ndjson',
  python: 'python-tutorial-1.0.0.ndjson',
  golang: 'golang-tutorial-1.0.0.ndjson',
};

export const assetMapper = (tutorialId: TutorialId): string => {
  return assetMap[tutorialId] || '';
};

• maybe use concatenations like ${component}-${indexPattens}-${version}-${signal}.ndjson
• provides a default return?

Also similar question: are these files coming from integration? If so, do we need to maintain these files from within get started module? Can't we just fetch from somewhere?

[TackAdam]

These are all currently manually created.

[TackAdam]

Adjusted it to be

export const assetMapper = (tutorialId: TutorialId): string => {
  const component = COMPONENT_MAP[tutorialId] || 'default-component';
  const version = VERSION_MAP[tutorialId] || '1.0.0';
  const signal = SIGNAL_MAP[tutorialId] ? `-${SIGNAL_MAP[tutorialId]}` : '';

  return `${component}-${version}${signal}.ndjson`;
};

and moved others to constants.

[mengweieric]

Could we also add tests to some of these changes?

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/dashboards-observability/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/dashboards-observability/backport-2.x
# Create a new branch
git switch --create backport/backport-2194-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f68eba1c45920df2866875dd5542cfe805e3f241
# Push it to GitHub
git push --set-upstream origin backport/backport-2194-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/dashboards-observability/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-2194-to-2.x.