Skip to content

Commit

Permalink
[skip ci] Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
badboy committed Jan 10, 2025
1 parent a77abad commit 41b2e87
Show file tree
Hide file tree
Showing 339 changed files with 362 additions and 376 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ <h1 id="instrumenting-android-crashes-with-the-glean-sdk"><a class="header" href
<p><strong>Note:</strong> This is a <em>very</em> simple example of instrumenting crashes using the Glean SDK. There will be challenges to
using this approach in a production application that should be considered. For instance, when an app crashes it can be in an
unknown state and may not be able to do things like upload data to a server. The recommended way of instrumenting crashes with
Android Components is called <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/components/lib/crash">lib-crash</a>, which takes into consideration things like multiple processes and persistence.</p>
Android Components is called <a href="https://searchfox.org/mozilla-central/source/mobile/android/android-components/components/lib/crash">lib-crash</a>, which takes into consideration things like multiple processes and persistence.</p>
<h2 id="before-you-start"><a class="header" href="#before-you-start">Before You Start</a></h2>
<p>There are a few things that need to be installed in order to proceed, mainly <a href="https://developer.android.com/studio/">Android Studio</a>. If you include the Android SDK,
Android Studio can take a little while to download and get installed. This walk-through assumes some knowledge of Android
Expand Down
4 changes: 1 addition & 3 deletions book/language-bindings/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,7 @@ <h3 id="kotlin"><a class="header" href="#kotlin">Kotlin</a></h3>
<p>The Glean Kotlin SDK is primarily used for integration with Android applications.
It assumes a common interaction model for mobile applications.
It sends builtin pings at startup of the integrating application.</p>
<p>It is available standalone as <code>org.mozilla.telemetry:glean</code>
or via <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/">Android Components</a> as <code>org.mozilla.components:service-glean</code>
from the <a href="https://maven.mozilla.org/?prefix=maven2">Mozilla Maven instance</a>.</p>
<p>It is available standalone as <code>org.mozilla.telemetry:glean</code> from the <a href="https://maven.mozilla.org/?prefix=maven2">Mozilla Maven instance</a>.</p>
<p>The Kotlin SDK can also be used from Java.</p>
<p>See <a href="android/">Android</a> for more on integrating Glean on Android.</p>
<h3 id="swift"><a class="header" href="#swift">Swift</a></h3>
Expand Down
28 changes: 10 additions & 18 deletions book/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -336,18 +336,16 @@ <h2 id="setting-up-the-dependency"><a class="header" href="#setting-up-the-depen
</code></pre>
<p>Each module that uses the Glean Kotlin SDK needs to specify it in its build file, in the <code>dependencies</code> block.
Add this to your Gradle configuration:</p>
<pre><code class="language-Groovy">implementation &quot;org.mozilla.components:service-glean:{latest-version}&quot;
<pre><code class="language-Groovy">implementation &quot;org.mozilla.telemetry:glean:{latest-version}&quot;
</code></pre>
<div class="special-quote special-quote-warning fa fa-exclamation-triangle"></div>
<h5 id="pick-the-correct-version"><a class="header" href="#pick-the-correct-version">Pick the correct version</a></h5>
<blockquote>
<p>The <code>{latest-version}</code> placeholder in the above link should be replaced with the version of Android Components used by the project.</p>
</blockquote>
<p>The Glean Kotlin SDK is released as part of <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/">android-components</a>. Therefore, it follows android-components' versions.
The <a href="https://github.com/mozilla-mobile/android-components/releases/">android-components release page</a> can be used to determine the latest version.</p>
<p>For example, if version <em>33.0.0</em> is used, then the include directive becomes:</p>
<pre><code class="language-Groovy">implementation &quot;org.mozilla.components:service-glean:33.0.0&quot;
<p>The <code>{latest-version}</code> placeholder in the above link should be replaced with the <a href="https://github.com/mozilla/glean/releases">latest version of the Glean SDK</a>.</p>
<p>For example, if version <em>63.0.0</em> is the latest version, then the include directive becomes:</p>
<pre><code class="language-Groovy">implementation &quot;org.mozilla.telemetry:glean:63.0.0&quot;
</code></pre>
</blockquote>
<div class="special-quote special-quote-info fa fa-info-circle"></div>
<h5 id="size-impact-on-the-application-apk"><a class="header" href="#size-impact-on-the-application-apk">Size impact on the application APK</a></h5>
<blockquote>
Expand All @@ -374,26 +372,22 @@ <h2 id="setting-up-metrics-and-pings-code-generation"><a class="header" href="#s
<li>JetBrains' <a href="https://github.com/JetBrains/gradle-python-envs/">Python envs plugin</a></li>
</ul>
<p>The Glean Gradle plugin is distributed through Mozilla's Maven, so we need to tell your build where to look for it by adding the following to the top of your <code>build.gradle</code>:</p>
<pre><code>buildscript {
<pre><code class="language-Groovy">buildscript {
repositories {
// Include the next clause if you are tracking snapshots of android components
maven {
url &quot;https://snapshots.maven.mozilla.org/maven2&quot;
}
maven {
url &quot;https://maven.mozilla.org/maven2&quot;
}

dependencies {
classpath &quot;org.mozilla.components:tooling-glean-gradle:{android-components-version}&quot;
classpath &quot;org.mozilla.telemetry:glean-gradle-plugin:{latest-version}&quot;
}
}
}
</code></pre>
<div class="special-quote special-quote-warning fa fa-exclamation-triangle"></div>
<h5 id="important"><a class="header" href="#important">Important</a></h5>
<blockquote>
<p>As above, the <code>{android-components-version}</code> placeholder in the above link should be replaced with the version number of android components used in your project.</p>
<p>As above, the <code>{latest-components-version}</code> placeholder in the above link should be replaced with the version number of the Glean SDK used in your project.</p>
</blockquote>
<p>The JetBrains Python plugin is distributed in the Gradle plugin repository, so it can be included with:</p>
<pre><code class="language-Groovy">plugins {
Expand Down Expand Up @@ -12866,9 +12860,7 @@ <h3 id="kotlin"><a class="header" href="#kotlin">Kotlin</a></h3>
<p>The Glean Kotlin SDK is primarily used for integration with Android applications.
It assumes a common interaction model for mobile applications.
It sends builtin pings at startup of the integrating application.</p>
<p>It is available standalone as <code>org.mozilla.telemetry:glean</code>
or via <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/">Android Components</a> as <code>org.mozilla.components:service-glean</code>
from the <a href="https://maven.mozilla.org/?prefix=maven2">Mozilla Maven instance</a>.</p>
<p>It is available standalone as <code>org.mozilla.telemetry:glean</code> from the <a href="https://maven.mozilla.org/?prefix=maven2">Mozilla Maven instance</a>.</p>
<p>The Kotlin SDK can also be used from Java.</p>
<p>See <a href="language-bindings/android/">Android</a> for more on integrating Glean on Android.</p>
<h3 id="swift"><a class="header" href="#swift">Swift</a></h3>
Expand Down Expand Up @@ -13026,7 +13018,7 @@ <h3 id="provide-a-python-interpreter-and-the-required-wheels"><a class="header"
<p><strong>Note:</strong> This is a <em>very</em> simple example of instrumenting crashes using the Glean SDK. There will be challenges to
using this approach in a production application that should be considered. For instance, when an app crashes it can be in an
unknown state and may not be able to do things like upload data to a server. The recommended way of instrumenting crashes with
Android Components is called <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/components/lib/crash">lib-crash</a>, which takes into consideration things like multiple processes and persistence.</p>
Android Components is called <a href="https://searchfox.org/mozilla-central/source/mobile/android/android-components/components/lib/crash">lib-crash</a>, which takes into consideration things like multiple processes and persistence.</p>
<h2 id="before-you-start"><a class="header" href="#before-you-start">Before You Start</a></h2>
<p>There are a few things that need to be installed in order to proceed, mainly <a href="https://developer.android.com/studio/">Android Studio</a>. If you include the Android SDK,
Android Studio can take a little while to download and get installed. This walk-through assumes some knowledge of Android
Expand Down
2 changes: 1 addition & 1 deletion book/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion book/searchindex.json

Large diffs are not rendered by default.

22 changes: 8 additions & 14 deletions book/user/adding-glean-to-your-project/kotlin.html
Original file line number Diff line number Diff line change
Expand Up @@ -199,18 +199,16 @@ <h2 id="setting-up-the-dependency"><a class="header" href="#setting-up-the-depen
</code></pre>
<p>Each module that uses the Glean Kotlin SDK needs to specify it in its build file, in the <code>dependencies</code> block.
Add this to your Gradle configuration:</p>
<pre><code class="language-Groovy">implementation &quot;org.mozilla.components:service-glean:{latest-version}&quot;
<pre><code class="language-Groovy">implementation &quot;org.mozilla.telemetry:glean:{latest-version}&quot;
</code></pre>
<div class="special-quote special-quote-warning fa fa-exclamation-triangle"></div>
<h5 id="pick-the-correct-version"><a class="header" href="#pick-the-correct-version">Pick the correct version</a></h5>
<blockquote>
<p>The <code>{latest-version}</code> placeholder in the above link should be replaced with the version of Android Components used by the project.</p>
</blockquote>
<p>The Glean Kotlin SDK is released as part of <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/">android-components</a>. Therefore, it follows android-components' versions.
The <a href="https://github.com/mozilla-mobile/android-components/releases/">android-components release page</a> can be used to determine the latest version.</p>
<p>For example, if version <em>33.0.0</em> is used, then the include directive becomes:</p>
<pre><code class="language-Groovy">implementation &quot;org.mozilla.components:service-glean:33.0.0&quot;
<p>The <code>{latest-version}</code> placeholder in the above link should be replaced with the <a href="https://github.com/mozilla/glean/releases">latest version of the Glean SDK</a>.</p>
<p>For example, if version <em>63.0.0</em> is the latest version, then the include directive becomes:</p>
<pre><code class="language-Groovy">implementation &quot;org.mozilla.telemetry:glean:63.0.0&quot;
</code></pre>
</blockquote>
<div class="special-quote special-quote-info fa fa-info-circle"></div>
<h5 id="size-impact-on-the-application-apk"><a class="header" href="#size-impact-on-the-application-apk">Size impact on the application APK</a></h5>
<blockquote>
Expand All @@ -237,26 +235,22 @@ <h2 id="setting-up-metrics-and-pings-code-generation"><a class="header" href="#s
<li>JetBrains' <a href="https://github.com/JetBrains/gradle-python-envs/">Python envs plugin</a></li>
</ul>
<p>The Glean Gradle plugin is distributed through Mozilla's Maven, so we need to tell your build where to look for it by adding the following to the top of your <code>build.gradle</code>:</p>
<pre><code>buildscript {
<pre><code class="language-Groovy">buildscript {
repositories {
// Include the next clause if you are tracking snapshots of android components
maven {
url &quot;https://snapshots.maven.mozilla.org/maven2&quot;
}
maven {
url &quot;https://maven.mozilla.org/maven2&quot;
}

dependencies {
classpath &quot;org.mozilla.components:tooling-glean-gradle:{android-components-version}&quot;
classpath &quot;org.mozilla.telemetry:glean-gradle-plugin:{latest-version}&quot;
}
}
}
</code></pre>
<div class="special-quote special-quote-warning fa fa-exclamation-triangle"></div>
<h5 id="important"><a class="header" href="#important">Important</a></h5>
<blockquote>
<p>As above, the <code>{android-components-version}</code> placeholder in the above link should be replaced with the version number of android components used in your project.</p>
<p>As above, the <code>{latest-components-version}</code> placeholder in the above link should be replaced with the version number of the Glean SDK used in your project.</p>
</blockquote>
<p>The JetBrains Python plugin is distributed in the Gradle plugin repository, so it can be included with:</p>
<pre><code class="language-Groovy">plugins {
Expand Down
9 changes: 5 additions & 4 deletions dev/cut-a-new-release.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,8 @@ <h1 id="glean-release-process"><a class="header" href="#glean-release-process">G
<li><a href="#standard-release">Standard release</a></li>
<li><a href="#hotfix-release-for-latest-version">Hotfix release for latest version</a></li>
<li><a href="#hotfix-release-for-previous-version">Hotfix release for previous version</a></li>
<li><a href="#upgrading-android-components-to-a-new-version-of-glean">Upgrading android-components to a new version of Glean</a></li>
<li><a href="#upgrading-mozilla-central-to-a-new-version-of-glean">Upgrading mozilla-central to a new version of Glean</a></li>
<li><a href="#recovering-from-a-failed-automated-release">Recovering from a failed automated release</a></li>
</ul>
<h2 id="published-artifacts"><a class="header" href="#published-artifacts">Published artifacts</a></h2>
<ul>
Expand Down Expand Up @@ -437,9 +438,9 @@ <h3 id="finish-a-support-branch"><a class="header" href="#finish-a-support-branc
</li>
<li>Once the above pull request lands, delete the support branch.</li>
</ol>
<h2 id="upgrading-android-components-to-a-new-version-of-glean"><a class="header" href="#upgrading-android-components-to-a-new-version-of-glean">Upgrading android-components to a new version of Glean</a></h2>
<p>On Android, Mozilla products consume the Glean SDK through its wrapper in <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/"><code>android-components</code></a>.
The process of vendoring a new version of Glean in to Mozilla Central now handles the upgrade process for android-components and no manual updating is needed here.</p>
<h2 id="upgrading-mozilla-central-to-a-new-version-of-glean"><a class="header" href="#upgrading-mozilla-central-to-a-new-version-of-glean">Upgrading mozilla-central to a new version of Glean</a></h2>
<p>Glean is integrated into Mozilla products in mozilla-central (Firefox Desktop, Firefox for Android, Focus for Android).
See <a href="https://firefox-source-docs.mozilla.org/toolkit/components/glean/dev/updating_sdk.html">Updating the Glean SDK</a> on how to update the Glean SDK in mozilla-central.</p>
<h2 id="recovering-from-a-failed-automated-release"><a class="header" href="#recovering-from-a-failed-automated-release">Recovering from a failed automated release</a></h2>
<p>In rare circumstances the automated release on CI can fail to publish updated packages.
This usually can be fixed with some manual steps.</p>
Expand Down
9 changes: 5 additions & 4 deletions dev/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,8 @@ <h3 id="release-like-android-builds"><a class="header" href="#release-like-andro
<li><a href="cut-a-new-release.html#standard-release">Standard release</a></li>
<li><a href="cut-a-new-release.html#hotfix-release-for-latest-version">Hotfix release for latest version</a></li>
<li><a href="cut-a-new-release.html#hotfix-release-for-previous-version">Hotfix release for previous version</a></li>
<li><a href="cut-a-new-release.html#upgrading-android-components-to-a-new-version-of-glean">Upgrading android-components to a new version of Glean</a></li>
<li><a href="cut-a-new-release.html#upgrading-mozilla-central-to-a-new-version-of-glean">Upgrading mozilla-central to a new version of Glean</a></li>
<li><a href="cut-a-new-release.html#recovering-from-a-failed-automated-release">Recovering from a failed automated release</a></li>
</ul>
<h2 id="published-artifacts"><a class="header" href="#published-artifacts">Published artifacts</a></h2>
<ul>
Expand Down Expand Up @@ -588,9 +589,9 @@ <h3 id="finish-a-support-branch"><a class="header" href="#finish-a-support-branc
</li>
<li>Once the above pull request lands, delete the support branch.</li>
</ol>
<h2 id="upgrading-android-components-to-a-new-version-of-glean"><a class="header" href="#upgrading-android-components-to-a-new-version-of-glean">Upgrading android-components to a new version of Glean</a></h2>
<p>On Android, Mozilla products consume the Glean SDK through its wrapper in <a href="https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/"><code>android-components</code></a>.
The process of vendoring a new version of Glean in to Mozilla Central now handles the upgrade process for android-components and no manual updating is needed here.</p>
<h2 id="upgrading-mozilla-central-to-a-new-version-of-glean"><a class="header" href="#upgrading-mozilla-central-to-a-new-version-of-glean">Upgrading mozilla-central to a new version of Glean</a></h2>
<p>Glean is integrated into Mozilla products in mozilla-central (Firefox Desktop, Firefox for Android, Focus for Android).
See <a href="https://firefox-source-docs.mozilla.org/toolkit/components/glean/dev/updating_sdk.html">Updating the Glean SDK</a> on how to update the Glean SDK in mozilla-central.</p>
<h2 id="recovering-from-a-failed-automated-release"><a class="header" href="#recovering-from-a-failed-automated-release">Recovering from a failed automated release</a></h2>
<p>In rare circumstances the automated release on CI can fail to publish updated packages.
This usually can be fixed with some manual steps.</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/searchindex.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion swift/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -1931,7 +1931,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2025 <a class="link" href="https://mozilla.github.com/glean" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2025-01-07)</p>
<p>&copy; 2025 <a class="link" href="https://mozilla.github.com/glean" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2025-01-10)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion swift/Classes/BooleanMetric.html
Original file line number Diff line number Diff line change
Expand Up @@ -1215,7 +1215,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2025 <a class="link" href="https://mozilla.github.com/glean" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2025-01-07)</p>
<p>&copy; 2025 <a class="link" href="https://mozilla.github.com/glean" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2025-01-10)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
2 changes: 1 addition & 1 deletion swift/Classes/BooleanMetric/NoPointer.html
Original file line number Diff line number Diff line change
Expand Up @@ -1002,7 +1002,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2025 <a class="link" href="https://mozilla.github.com/glean" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2025-01-07)</p>
<p>&copy; 2025 <a class="link" href="https://mozilla.github.com/glean" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2025-01-10)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 41b2e87

Please sign in to comment.