Skip to content

feat(metrics): Add metrics onboarding for Android and Java #67033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import ExternalLink from 'sentry/components/links/externalLink';
import Link from 'sentry/components/links/link';
import type {StepProps} from 'sentry/components/onboarding/gettingStartedDoc/step';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import type {
Expand Down Expand Up @@ -197,6 +198,253 @@ export const getJSServerMetricsOnboarding = (): OnboardingConfig => ({
],
});

const getJvmKotlinConfigureSnippet = (params: DocsParams) => `
import io.sentry.Sentry

Sentry.init(this) { options ->
options.dsn = "${params.dsn}",
options.enableMetrics = true
}`;

const getJvmJavaConfigureSnippet = (params: DocsParams) => `
import io.sentry.Sentry;

Sentry.init(this, options -> {
options.setDsn("${params.dsn}");
options.setEnableMetrics(true);
});`;

const getAndroidKotlinConfigureSnippet = (params: DocsParams) => `
import io.sentry.android.core.SentryAndroid

SentryAndroid.init(this) { options ->
options.dsn = "${params.dsn}",
options.enableMetrics = true
}`;

const getAndroidJavaConfigureSnippet = (params: DocsParams) => `
import io.sentry.android.core.SentryAndroid;

SentryAndroid.init(this, options -> {
options.setDsn("${params.dsn}");
options.setEnableMetrics(true);
});`;

const getAndroidXmlConfigureSnippet = (params: DocsParams) => `
<manifest>
<application>
<meta-data android:name="io.sentry.dsn" android:value="${params.dsn}" />
<meta-data android:name="io.sentry.enable-metrics" android:value="true" />
</application>
</manifest>`;

const getJvmPropertiesConfigureSnippet = (_: DocsParams) => `
sentry.enable-metrics=true`;

const getJvmJavaVerifySnippet = () => `
// Add 4 to a counter named "hits"
Sentry.metrics().increment("hits", 4);`;

const getJvmKotlinVerifySnippet = () => `
// Add 4 to a counter named "hits"
Sentry.metrics().increment("hits", 4)`;

export const getAndroidMetricsOnboarding = (): OnboardingConfig => ({
install: (params: DocsParams) => [
{
type: StepType.INSTALL,
description: tct(
'You need [package:sentry-java] version [codeVersion:7.6.0] or higher. Follow our [docsLink:setup wizard] to learn more about setting up the Android SDK.',
{
package: <code />,
codeVersion: <code />,
docsLink: <Link to={`/projects/${params.projectSlug}/getting-started/`} />,
}
),
},
],
configure: (params: DocsParams) => [
{
type: StepType.CONFIGURE,
description: 'To enable capturing metrics, you need to enable the metrics feature.',
configurations: [
{
code: [
{
label: 'Kotlin',
value: 'java',
language: 'java',
code: getAndroidKotlinConfigureSnippet(params),
},
{
label: 'Java',
value: 'kotlin',
language: 'java',
code: getAndroidJavaConfigureSnippet(params),
},
{
label: 'XML',
value: 'xml',
language: 'java',
code: getAndroidXmlConfigureSnippet(params),
},
],
},
],
},
],
verify: () => [
{
type: StepType.VERIFY,
description: tct(
"Then you'll be able to add metrics as [codeCounters:counters], [codeSets:sets], [codeDistribution:distributions], and [codeGauge:gauges]. These are available under the [codeNamespace:Sentry.metrics()] namespace. Try out this example:",
{
codeCounters: <code />,
codeSets: <code />,
codeDistribution: <code />,
codeGauge: <code />,
codeNamespace: <code />,
}
),
configurations: [
{
configurations: [
{
code: [
{
label: 'Kotlin',
value: 'kotlin',
language: 'java',
code: getJvmKotlinVerifySnippet(),
},
{
label: 'Java',
value: 'java',
language: 'java',
code: getJvmJavaVerifySnippet(),
},
],
},
],
},
{
description: t(
'With a bit of delay you can see the data appear in the Sentry UI.'
),
},
{
description: tct(
'Learn more about metrics and how to configure them, by reading the [docsLink:docs].',
{
docsLink: (
<ExternalLink href="https://docs.sentry.io/platforms/android/metrics/" />
),
}
),
},
],
},
],
});

export const getJavaMetricsOnboarding = (): OnboardingConfig => ({
install: (params: DocsParams) => [
{
type: StepType.INSTALL,
description: tct(
'You need [package:sentry-java] version [codeVersion:7.6.0] or higher. Follow our [docsLink:setup wizard] to learn more about setting up the Java SDK.',
{
package: <code />,
codeVersion: <code />,
docsLink: <Link to={`/projects/${params.projectSlug}/getting-started`} />,
}
),
},
],
configure: params => [
{
type: StepType.CONFIGURE,
description: 'To enable capturing metrics, you need to enable the metrics feature.',
configurations: [
{
code: [
{
label: 'Java',
value: 'java',
language: 'java',
code: getJvmJavaConfigureSnippet(params),
},
{
label: 'Kotlin',
value: 'kotlin',
language: 'java',
code: getJvmKotlinConfigureSnippet(params),
},
{
label: 'properties',
value: 'properties',
language: 'properties',
code: getJvmPropertiesConfigureSnippet(params),
},
],
},
],
},
],
verify: () => [
{
type: StepType.VERIFY,
description: tct(
"Then you'll be able to add metrics as [codeCounters:counters], [codeSets:sets], [codeDistribution:distributions], and [codeGauge:gauges]. These are available under the [codeNamespace:Sentry.metrics()] namespace. Try out this example:",
{
codeCounters: <code />,
codeSets: <code />,
codeDistribution: <code />,
codeGauge: <code />,
codeNamespace: <code />,
}
),
configurations: [
{
configurations: [
{
code: [
{
label: 'Java',
value: 'java',
language: 'java',
code: getJvmJavaVerifySnippet(),
},
{
label: 'Kotlin',
value: 'kotlin',
language: 'java',
code: getJvmKotlinVerifySnippet(),
},
],
},
],
},
{
description: t(
'With a bit of delay you can see the data appear in the Sentry UI.'
),
},
{
description: tct(
'Learn more about metrics and how to configure them, by reading the [docsLink:docs].',
{
docsLink: (
<ExternalLink href="https://docs.sentry.io/platforms/java/metrics/" />
),
}
),
},
],
},
],
});

const getPythonConfigureSnippet = () => `
import sentry_sdk

Expand Down
10 changes: 10 additions & 0 deletions static/app/data/platformCategories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,14 @@ const customMetricBackendPlatforms: readonly PlatformKey[] = [
'dotnet-uwp',
'dotnet-winforms',
'dotnet-wpf',
'java',
'java-appengine',
'java-log4j',
'java-log4j2',
'java-logback',
'java-logging',
'java-spring',
'java-spring-boot',
'php',
'php-laravel',
// TODO: Enable once metrics are available for Symfony
Expand Down Expand Up @@ -499,7 +507,9 @@ const customMetricBackendPlatforms: readonly PlatformKey[] = [
];

const customMetricFrontendPlatforms: readonly PlatformKey[] = [
'android',
'electron',
'java-android',
'javascript-angular',
'javascript-astro',
'javascript-backbone',
Expand Down
2 changes: 2 additions & 0 deletions static/app/gettingStartedDocs/android/android.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import type {
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {getAndroidMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {feedbackOnboardingCrashApiJava} from 'sentry/gettingStartedDocs/java/java';
import {t, tct} from 'sentry/locale';
import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion';
Expand Down Expand Up @@ -286,6 +287,7 @@ const docs: Docs<PlatformOptions> = {
onboarding,
feedbackOnboardingCrashApi: feedbackOnboardingCrashApiJava,
crashReportOnboarding: feedbackOnboardingCrashApiJava,
customMetricsOnboarding: getAndroidMetricsOnboarding(),
platformOptions,
};

Expand Down
2 changes: 2 additions & 0 deletions static/app/gettingStartedDocs/java/java.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
getCrashReportApiIntroduction,
getCrashReportInstallDescription,
} from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding';
import {getJavaMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {t, tct} from 'sentry/locale';
import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion';

Expand Down Expand Up @@ -350,6 +351,7 @@ const docs: Docs<PlatformOptions> = {
platformOptions,
feedbackOnboardingCrashApi: feedbackOnboardingCrashApiJava,
crashReportOnboarding: feedbackOnboardingCrashApiJava,
customMetricsOnboarding: getJavaMetricsOnboarding(),
onboarding,
};

Expand Down
2 changes: 2 additions & 0 deletions static/app/gettingStartedDocs/java/log4j2.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {getJavaMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {feedbackOnboardingCrashApiJava} from 'sentry/gettingStartedDocs/java/java';
import {t, tct} from 'sentry/locale';
import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion';
Expand Down Expand Up @@ -334,6 +335,7 @@ const docs: Docs<PlatformOptions> = {
platformOptions,
feedbackOnboardingCrashApi: feedbackOnboardingCrashApiJava,
crashReportOnboarding: feedbackOnboardingCrashApiJava,
customMetricsOnboarding: getJavaMetricsOnboarding(),
onboarding,
};

Expand Down
2 changes: 2 additions & 0 deletions static/app/gettingStartedDocs/java/logback.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {getJavaMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {feedbackOnboardingCrashApiJava} from 'sentry/gettingStartedDocs/java/java';
import {t, tct} from 'sentry/locale';
import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion';
Expand Down Expand Up @@ -341,6 +342,7 @@ const docs: Docs<PlatformOptions> = {
onboarding,
feedbackOnboardingCrashApi: feedbackOnboardingCrashApiJava,
crashReportOnboarding: feedbackOnboardingCrashApiJava,
customMetricsOnboarding: getJavaMetricsOnboarding(),
platformOptions,
};

Expand Down
2 changes: 2 additions & 0 deletions static/app/gettingStartedDocs/java/spring-boot.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {getJavaMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {feedbackOnboardingCrashApiJava} from 'sentry/gettingStartedDocs/java/java';
import replayOnboardingJsLoader from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
import {t, tct} from 'sentry/locale';
Expand Down Expand Up @@ -304,6 +305,7 @@ const docs: Docs<PlatformOptions> = {
platformOptions,
replayOnboardingJsLoader,
crashReportOnboarding: feedbackOnboardingCrashApiJava,
customMetricsOnboarding: getJavaMetricsOnboarding(),
};

export default docs;
2 changes: 2 additions & 0 deletions static/app/gettingStartedDocs/java/spring.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {getJavaMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {feedbackOnboardingCrashApiJava} from 'sentry/gettingStartedDocs/java/java';
import replayOnboardingJsLoader from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
import {t, tct} from 'sentry/locale';
Expand Down Expand Up @@ -376,6 +377,7 @@ const docs: Docs<PlatformOptions> = {
platformOptions,
crashReportOnboarding: feedbackOnboardingCrashApiJava,
replayOnboardingJsLoader,
customMetricsOnboarding: getJavaMetricsOnboarding(),
};

export default docs;