Multi-tenancy support for trace analytics

.cypress/integration/panels_test/panels.spec.ts

@@ -70,7 +70,11 @@ describe('Panels testing with Sample Data', { defaultCommandTimeout: 10000 }, ()
       // cy.get('[id^=autocomplete-textarea]').focus().type(PPL_VISUALIZATIONS[1], {
       //   delay: 50,
       // });
-      cy.get('[id^=autocomplete-textarea]').focus().invoke('val', PPL_VISUALIZATIONS[1]).trigger('input').trigger('change');
+      cy.get('[id^=autocomplete-textarea]')
+        .focus()
+        .invoke('val', PPL_VISUALIZATIONS[1])
+        .trigger('input')
+        .trigger('change');
       cy.get('.euiButton__text').contains('Run').trigger('mouseover').click();
       cy.get('button[id="main-content-vis"]')
         .contains('Visualizations')

common/utils/tenant_index_name.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export function getTenantIndexName(indexName: string, tenantName?: string) {
+  if (indexName.charAt(indexName.length - 1) === '*') {
+    indexName = indexName.slice(0, -1);
+  }
+
+  if (tenantName) {
+    if (indexName.charAt(indexName.length - 1) !== '-') indexName += '-';
+    indexName += `${tenantName.toLowerCase()}`;
+  }
+
+  return indexName + '*';
+}

public/components/app.tsx

@@ -28,6 +28,7 @@ interface ObservabilityAppDeps {
   pplService: any;
   dslService: any;
   savedObjects: any;
+  config: PublicConfig;
   timestampUtils: any;
   queryManager: QueryManager;
   startPage: string;
@@ -59,6 +60,7 @@ export const App = ({
   pplService,
   dslService,
   savedObjects,
+  config,
   timestampUtils,
   queryManager,
   startPage,
@@ -68,7 +70,7 @@ export const App = ({
   dataSourceEnabled,
   savedObjectsMDSClient,
 }: ObservabilityAppDeps) => {
-  const { chrome, http, notifications, savedObjects: coreSavedObjects } = CoreStartProp;
+  const { chrome, http, notifications } = CoreStartProp;
   const parentBreadcrumb = {
     text: observabilityTitle,
     href: `${observabilityID}#/`,
@@ -92,6 +94,7 @@ export const App = ({
             pplService={pplService}
             dslService={dslService}
             savedObjects={savedObjects}
+            config={config}
             timestampUtils={timestampUtils}
             queryManager={queryManager}
             parentBreadcrumb={parentBreadcrumb}

public/components/application_analytics/components/config_components/service_config.tsx

@@ -38,6 +38,7 @@ export const ServiceConfig = (props: ServiceConfigProps) => {
     http,
     selectedServices,
     setSelectedServices,
+    tenant,
   } = props;
   const { mode } = props;
   const [servicesOpen, setServicesOpen] = useState(false);
@@ -49,7 +50,7 @@ export const ServiceConfig = (props: ServiceConfigProps) => {
   const [modalLayout, setModalLayout] = useState(<EuiOverlayMask />);
 
   useEffect(() => {
-    handleServiceMapRequest(http, dslService, mode, '', setServiceMap);
+    handleServiceMapRequest(http, dslService, mode, '', setServiceMap, undefined, tenant);
   }, []);
 
   useEffect(() => {

public/components/application_analytics/components/flyout_components/service_detail_flyout.tsx

@@ -48,6 +48,7 @@ export function ServiceDetailFlyout(props: ServiceFlyoutProps) {
     closeServiceFlyout,
     openSpanFlyout,
     mode,
+    tenant,
   } = props;
   const [fields, setFields] = useState<any>({});
   const [serviceMap, setServiceMap] = useState<ServiceObject>({});
@@ -131,7 +132,7 @@ export function ServiceDetailFlyout(props: ServiceFlyoutProps) {
       appConfigs
     );
     handleServiceViewRequest(serviceName, http, serviceDSL, setFields, mode);
-    handleServiceMapRequest(http, serviceDSL, mode, '', setServiceMap, serviceName);
+    handleServiceMapRequest(http, serviceDSL, mode, '', setServiceMap, serviceName, tenant);
     const spanDSL = filtersToDsl(mode, filters, query, startTime, endTime, 'app', appConfigs);
     spanDSL.query.bool.must.push({
       term: {

public/components/application_analytics/components/flyout_components/trace_detail_render.tsx

@@ -20,10 +20,17 @@ interface TraceDetailRenderProps {
   traceId: string;
   http: HttpStart;
   openSpanFlyout: (spanId: string) => void;
-  mode : TraceAnalyticsMode
+  mode: TraceAnalyticsMode;
+  tenant?: string;
 }
 
-export const TraceDetailRender = ({ traceId, http, openSpanFlyout, mode }: TraceDetailRenderProps) => {
+export const TraceDetailRender = ({
+  traceId,
+  http,
+  openSpanFlyout,
+  mode,
+  tenant,
+}: TraceDetailRenderProps) => {
   const [fields, setFields] = useState<any>({});
   const [serviceBreakdownData, setServiceBreakdownData] = useState([]);
   const [payloadData, setPayloadData] = useState('');
@@ -86,9 +93,16 @@ export const TraceDetailRender = ({ traceId, http, openSpanFlyout, mode }: Trace
   }, [traceId, fields, serviceBreakdownData, colorMap, payloadData]);
 
   useEffect(() => {
-    handleTraceViewRequest(traceId, http, fields, setFields, mode);
-    handleServicesPieChartRequest(traceId, http, setServiceBreakdownData, setColorMap, mode);
-    handlePayloadRequest(traceId, http, payloadData, setPayloadData, mode);
+    handleTraceViewRequest(traceId, http, fields, setFields, mode, tenant);
+    handleServicesPieChartRequest(
+      traceId,
+      http,
+      setServiceBreakdownData,
+      setColorMap,
+      mode,
+      tenant
+    );
+    handlePayloadRequest(traceId, http, payloadData, setPayloadData, mode, tenant);
   }, [traceId]);
 
   return renderContent;

public/components/event_analytics/explorer/log_explorer.tsx

@@ -20,11 +20,6 @@ import { selectQueries } from '../redux/slices/query_slice';
 import { selectQueryTabs } from '../redux/slices/query_tab_slice';
 import { Explorer } from './explorer';
 import { getDateRange } from '../utils/utils';
-import {
-  QUERY_ASSIST_END_TIME,
-  QUERY_ASSIST_START_TIME,
-} from '../../../../common/constants/shared';
-import { coreRefs } from '../../../../public/framework/core_refs';
 
 const searchBarConfigs = {
   [TAB_EVENT_ID]: {

public/components/index.tsx

@@ -10,6 +10,7 @@ import { AppMountParameters, CoreStart } from '../../../../src/core/public';
 import { DataSourceManagementPluginSetup } from '../../../../src/plugins/data_source_management/public';
 import { AppPluginStartDependencies } from '../types';
 import { App } from './app';
+import { PublicConfig } from '../plugin';
 
 export const Observability = (
   CoreStartProp: CoreStart,
@@ -23,7 +24,8 @@ export const Observability = (
   startPage: string,
   dataSourcePluggables,
   dataSourceManagement: DataSourceManagementPluginSetup,
-  savedObjectsMDSClient: CoreStart['savedObjects']
+  savedObjectsMDSClient: CoreStart['savedObjects'],
+  config: PublicConfig
 ) => {
   const { setHeaderActionMenu } = AppMountParametersProp;
   const { dataSource } = DepsStart;
@@ -34,6 +36,7 @@ export const Observability = (
       pplService={pplService}
       dslService={dslService}
       savedObjects={savedObjects}
+      config={config}
       timestampUtils={timestampUtils}
       queryManager={queryManager}
       startPage={startPage}

public/components/trace_analytics/components/common/__tests__/__snapshots__/helper_functions.test.tsx.snap

@@ -116,6 +116,33 @@ exports[`Helper functions renders no match and missing configuration messages 2`
 </Fragment>
 `;
 
+exports[`Helper functions renders no match and missing configuration messages 3`] = `
+<Fragment>
+  <EuiEmptyPrompt
+    actions={
+      <EuiButton
+        color="primary"
+        iconSide="right"
+        iconType="popout"
+        onClick={[Function]}
+      >
+        Learn more
+      </EuiButton>
+    }
+    body={
+      <EuiText>
+        The indices required for trace analytics (otel-v1-apm-span-test* and otel-v1-apm-service-map-test*) do not exist or you do not have permission to access them.
+      </EuiText>
+    }
+    title={
+      <h2>
+        Trace Analytics not set up
+      </h2>
+    }
+  />
+</Fragment>
+`;
+
 exports[`Helper functions renders panel title 1`] = `
 <EuiText
   size="m"

public/components/trace_analytics/components/common/__tests__/helper_functions.test.tsx

@@ -5,7 +5,6 @@
 
 import { configure, mount, shallow } from 'enzyme';
 import Adapter from 'enzyme-adapter-react-16';
-import { TraceAnalyticsMode } from 'public/components/trace_analytics/home';
 import React from 'react';
 import { TEST_SERVICE_MAP, TEST_SERVICE_MAP_GRAPH } from '../../../../../../test/constants';
 import {
@@ -38,9 +37,15 @@ describe('Helper functions', () => {
 
   it('renders no match and missing configuration messages', () => {
     const noMatchMessage = shallow(<NoMatchMessage size="s" />);
-    const missingConfigurationMessage = shallow(<MissingConfigurationMessage mode='data_prepper'/>)
+    const missingConfigurationMessage = shallow(
+      <MissingConfigurationMessage mode="data_prepper" />
+    );
+    const missingConfigurationMessageWithTenant = shallow(
+      <MissingConfigurationMessage mode="data_prepper" tenant="test" />
+    );
     expect(noMatchMessage).toMatchSnapshot();
     expect(missingConfigurationMessage).toMatchSnapshot();
+    expect(missingConfigurationMessageWithTenant).toMatchSnapshot();
   });
 
   it('renders benchmark', () => {

public/components/trace_analytics/components/common/helper_functions.tsx

@@ -21,10 +21,7 @@ import { TraceAnalyticsMode } from '../../home';
 import { serviceMapColorPalette } from './color_palette';
 import { FilterType } from './filters/filters';
 import { ServiceObject } from './plots/service_map';
-
-const missingJaegerTracesConfigurationMessage = `The indices required for trace analytics (${JAEGER_INDEX_NAME} and ${JAEGER_SERVICE_INDEX_NAME}) do not exist or you do not have permission to access them.`;
-
-const missingDataPrepperTracesConfigurationMessage = `The indices required for trace analytics (${DATA_PREPPER_INDEX_NAME} and ${DATA_PREPPER_SERVICE_INDEX_NAME}) do not exist or you do not have permission to access them.`;
+import { getTenantIndexName } from '../../../../../common/utils/tenant_index_name';
 
 export function PanelTitle({ title, totalItems }: { title: string; totalItems?: number }) {
   return (
@@ -55,7 +52,23 @@ export function NoMatchMessage(props: { size: SpacerSize }) {
   );
 }
 
-export function MissingConfigurationMessage(props: { mode: TraceAnalyticsMode }) {
+export function MissingConfigurationMessage(props: { mode: TraceAnalyticsMode; tenant?: string }) {
+  const missingJaegerTracesConfigurationMessage = `The indices required for trace analytics (${getTenantIndexName(
+    JAEGER_INDEX_NAME,
+    props.tenant
+  )} and ${getTenantIndexName(
+    JAEGER_SERVICE_INDEX_NAME,
+    props.tenant
+  )}) do not exist or you do not have permission to access them.`;
+
+  const missingDataPrepperTracesConfigurationMessage = `The indices required for trace analytics (${getTenantIndexName(
+    DATA_PREPPER_INDEX_NAME,
+    props.tenant
+  )} and ${getTenantIndexName(
+    DATA_PREPPER_SERVICE_INDEX_NAME,
+    props.tenant
+  )}) do not exist or you do not have permission to access them.`;
+
   const missingConfigurationBody =
     props.mode === 'jaeger'
       ? missingJaegerTracesConfigurationMessage

public/components/trace_analytics/components/common/indices.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { CoreStart } from '../../../../../../../src/core/public';
+
+export async function loadTenantInfo(http: CoreStart['http'], multitenancyEnabled: boolean) {
+  if (!multitenancyEnabled) {
+    return;
+  }
+
+  return await http
+    .get('/api/v1/multitenancy/tenant')
+    .then((tenant) => {
+      if (tenant === '' || tenant === '__user__') {
+        tenant = '';
+      }
+      return tenant;
+    })
+    .catch((error) => {
+      if (error.body.statusCode === 404) {
+        // endpoint doesn't exist, security plugin is not enabled.
+        return undefined;
+      }
+      console.error(`failed to request tenant: ${String(error)}`);
+    });
+}

public/components/trace_analytics/components/dashboard/__tests__/dashboard.test.tsx

@@ -7,6 +7,7 @@ import { configure, mount } from 'enzyme';
 import Adapter from 'enzyme-adapter-react-16';
 import React from 'react';
 import { Dashboard } from '..';
+// eslint-disable-next-line jest/no-mocks-import
 import { coreStartMock } from '../../../../../../test/__mocks__/coreMocks';
 
 describe('Dashboard component', () => {