Writes trace events to the system trace buffer. These trace events can be
collected and visualized using the Systrace tool.
This tracing mechanism is independent of the method tracing mechanism
offered by startMethodTracing(). In particular, it enables
tracing of events that occur across multiple processes.
Writes a trace message to indicate that a given section of code has begun. This call must
be followed by a corresponding call to endSection() on the same thread.
At this time the vertical bar character '|', newline character '\n', and
null character '\0' are used internally by the tracing mechanism. If sectionName contains
these characters they will be replaced with a space character in the trace.
Parameters
sectionName
String: The name of the code section to appear in the trace. This may be at
most 127 Unicode code units long.
Writes a trace message to indicate that a given section of code has ended. This call must
be preceeded by a corresponding call to beginSection(String). Calling this method
will mark the end of the most recently begun section of code, so care must be taken to
ensure that beginSection / endSection pairs are properly nested and called from the same
thread.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# TraceCompat\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \nbelongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1 \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \\| [\\[Expand All\\]](#) \n\nTraceCompat\n===========\n\n| This package is part of the Android [support library](/topic/libraries/support-library) which is no longer maintained. The support library has been superseded by [AndroidX](/jetpack/androidx) which is part of [Jetpack](/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider [migrating](/jetpack/androidx/migrate) existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library [class\n| mappings](/jetpack/androidx/migrate/class-mappings).\n\n\n`\npublic\n\nfinal\n\nclass\nTraceCompat\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\n`\n\n|---|-----------------------------------|\n| java.lang.Object ||\n| ↳ | android.support.v4.os.TraceCompat |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nWrites trace events to the system trace buffer. These trace events can be\ncollected and visualized using the Systrace tool.\n\nThis tracing mechanism is independent of the method tracing mechanism\noffered by [startMethodTracing()](https://developer.android.com/reference/android/os/Debug.html#startMethodTracing()). In particular, it enables\ntracing of events that occur across multiple processes.\n\nFor information about using the Systrace tool, read [Analyzing Display and Performance\nwith Systrace](/tools/debugging/systrace).\n\nSummary\n-------\n\n| ### Public methods ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` static void` | ` `[beginSection](/reference/android/support/v4/os/TraceCompat#beginSection(java.lang.String))`(String sectionName) ` Writes a trace message to indicate that a given section of code has begun. |\n| ` static void` | ` `[endSection](/reference/android/support/v4/os/TraceCompat#endSection())`() ` Writes a trace message to indicate that a given section of code has ended. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class\u003c?\u003e` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||\n\nPublic methods\n--------------\n\n### beginSection\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nvoid beginSection (String sectionName)\n```\n\nWrites a trace message to indicate that a given section of code has begun. This call must\nbe followed by a corresponding call to [endSection()](/reference/android/support/v4/os/TraceCompat#endSection()) on the same thread.\n\nAt this time the vertical bar character '\\|', newline character '\\\\n', and\nnull character '\\\\0' are used internally by the tracing mechanism. If sectionName contains\nthese characters they will be replaced with a space character in the trace.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------------|------------------------------------------------------------------------------------------------------------------------|\n| `sectionName` | `String`: The name of the code section to appear in the trace. This may be at most 127 Unicode code units long. \u003cbr /\u003e |\n\n### endSection\n\nadded in [version 22.1.0](/topic/libraries/support-library/revisions) \n\n```\nvoid endSection ()\n```\n\nWrites a trace message to indicate that a given section of code has ended. This call must\nbe preceeded by a corresponding call to [beginSection(String)](/reference/android/support/v4/os/TraceCompat#beginSection(java.lang.String)). Calling this method\nwill mark the end of the most recently begun section of code, so care must be taken to\nensure that beginSection / endSection pairs are properly nested and called from the same\nthread.\n\n\u003cbr /\u003e\n\n-\n\n Interfaces\n ----------\n\n - [CancellationSignal.OnCancelListener](/reference/android/support/v4/os/CancellationSignal.OnCancelListener)\n - [ParcelableCompatCreatorCallbacks](/reference/android/support/v4/os/ParcelableCompatCreatorCallbacks)\n-\n\n Classes\n -------\n\n - [BuildCompat](/reference/android/support/v4/os/BuildCompat)\n - [CancellationSignal](/reference/android/support/v4/os/CancellationSignal)\n - [ConfigurationCompat](/reference/android/support/v4/os/ConfigurationCompat)\n - [EnvironmentCompat](/reference/android/support/v4/os/EnvironmentCompat)\n - [LocaleListCompat](/reference/android/support/v4/os/LocaleListCompat)\n - [ParcelableCompat](/reference/android/support/v4/os/ParcelableCompat)\n - [TraceCompat](/reference/android/support/v4/os/TraceCompat)\n - [UserManagerCompat](/reference/android/support/v4/os/UserManagerCompat)\n-\n\n Exceptions\n ----------\n\n - [OperationCanceledException](/reference/android/support/v4/os/OperationCanceledException)"]]