From Fedora Project Wiki
< Features
(Create new template for feature) |
(First try to document most parts.) |
||
| Line 7: | Line 7: | ||
= Feature Name = | = Feature Name = | ||
Systemtap Static Probes for userspace programs. | |||
== Summary == | == Summary == | ||
Systemtap allows event tracing of programs when they have static probes inserted. This allows for tracing specifics of an application on a higher level that is meaningful to the application user so they don't have to know the exact source code details for tracing what is happening. | |||
== Owner == | == Owner == | ||
<!--This should link to your home wiki page so we know who you are--> | <!--This should link to your home wiki page so we know who you are--> | ||
* Name: [[User: | * Name: [[User:MJW| Mark Wielaard]] | ||
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved--> | <!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or technical issues need to be resolved--> | ||
* email: | * email: mjw@redhat.com | ||
== Current status == | == Current status == | ||
* Targeted release: [[Releases/ | * Targeted release: [[Releases/11 | Fedora 11]] | ||
* Last updated: | * Last updated: January 19 2009 | ||
* Percentage of completion: | * Percentage of completion: 5% | ||
== Detailed Description == | |||
By packaging a new version of systemtap, that enables programs that already have static dtrace probe markers in their sources and by making those packages depend on the new systemtap (sub) and recompiling them with probe points enabled, users of those packages will be able to trace any high level events that these packages provide. | |||
== Benefit to Fedora == | == Benefit to Fedora == | ||
<!-- What is the benefit to the platform? If this is a major capability update, what has changed? If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?--> | <!-- What is the benefit to the platform? If this is a major capability update, what has changed? If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?--> | ||
It will be easier for developers and users to observe what is really happening on their system on a higher (application) level. | |||
== Scope == | == Scope == | ||
<!-- What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?--> | <!-- What work do the developers have to accomplish to complete the feature in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?--> | ||
* Work with upstream to identify any issues with the new capabilities while we activate probes in packages. | |||
* Package new version of Systemtap (including new subpackage systemtap-sdt-devel). | |||
* Identify packages that already include static user probes (postgresql, java-1.6.0-openjdk, mysql, xorg-x11-server, ...) | |||
* Work with package maintainer to enable them in the Fedora build spec file. | |||
* Add documentation on enabled probes and how to use them with a systemtap tapset. | |||
== How To Test == | == How To Test == | ||
| Line 50: | Line 57: | ||
--> | --> | ||
{{admon/important | Needs to be expanded | | |||
* Need a specific pacakage list. | |||
* For each package enabling probes a reference to the probe names. | |||
* And an simple example stap invocation listing markers that can be enabled. | |||
}} | |||
== User Experience == | == User Experience == | ||
For packages that have static probes enabled users will be able to trace high-level events, like for example database transactions, through stap. | |||
== Dependencies == | == Dependencies == | ||
<!-- What other packages (RPMs) depend on this package? Are there changes outside the developers' control on which completion of this feature depends? In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate? Other upstream projects like the kernel (if this is not a kernel feature)? --> | <!-- What other packages (RPMs) depend on this package? Are there changes outside the developers' control on which completion of this feature depends? In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate? Other upstream projects like the kernel (if this is not a kernel feature)? --> | ||
* A new version of systemtap with the systemtap-sdt-devel subpackage. | |||
* Any package wishing to expose existing probes in its (upstream) sources depending on systemtap-sdt-devel and adding an --enable-dtrace or equivalent to its spec file. | |||
* Not required for this feature, but since systemtap uses debuginfo, this feature is enhanced by the [[Features/DebugInfoRevamp | Debug Info Revamp Feature]]. | |||
== Contingency Plan == | == Contingency Plan == | ||
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "None necessary, revert to previous release behaviour." Or it might not. If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy. --> | <!-- If you cannot complete your feature by the final development freeze, what is the backup plan? This might be as simple as "None necessary, revert to previous release behaviour." Or it might not. If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy. --> | ||
Even if all the tracing will not work, packages that are converted to provide static probes will not be impacted since the probe points have (near) zero overhead, so in the worse case some packages were recompiled to enable the feature, but users will still not be able to use it. | |||
== Documentation == | == Documentation == | ||
<!-- Is there upstream documentation on this feature, or notes you have written yourself? Link to that material here so other interested developers can get involved. --> | <!-- Is there upstream documentation on this feature, or notes you have written yourself? Link to that material here so other interested developers can get involved. --> | ||
The upstream wiki is the best description for now http://sourceware.org/systemtap/wiki/UsingStaticUserMarkers the systemtap list has an example on converting a package http://sourceware.org/ml/systemtap/2009-q1/msg00140.html | |||
While working on this feature this section will be expanded to list packages that have probe points enabled and pointers to (upstream) package documentation on the probe names and semantics like for postgresql http://www.postgresql.org/docs/8.2/static/dynamic-trace.html | |||
== Release Notes == | == Release Notes == | ||
| Line 68: | Line 92: | ||
<!-- The Fedora Release Notes inform end-users about what is new in the release. Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ --> | <!-- The Fedora Release Notes inform end-users about what is new in the release. Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ --> | ||
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the documentation team and shipped with the release. --> | <!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns. If there are any such changes involved in this feature, indicate them here. You can also link to upstream documentation if it satisfies this need. This information forms the basis of the release notes edited by the documentation team and shipped with the release. --> | ||
* '''FIXME''': Should have some notes about the feature and which packages were enabled when finished. | |||
== Comments and Discussion == | == Comments and Discussion == | ||
* See [[Talk:Features/ | * See [[Talk:Features/SystemtapStaticProbes]] <!-- This adds a link to the "discussion" tab associated with your page. This provides the ability to have ongoing comments or conversation without bogging down the main feature page --> | ||
Revision as of 17:32, 19 January 2009
Comments and Explanations
The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "edit" link.
The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "edit" link.
Feature Name
Systemtap Static Probes for userspace programs.
Summary
Systemtap allows event tracing of programs when they have static probes inserted. This allows for tracing specifics of an application on a higher level that is meaningful to the application user so they don't have to know the exact source code details for tracing what is happening.
Owner
- Name: Mark Wielaard
- email: mjw@redhat.com
Current status
- Targeted release: Fedora 11
- Last updated: January 19 2009
- Percentage of completion: 5%
Detailed Description
By packaging a new version of systemtap, that enables programs that already have static dtrace probe markers in their sources and by making those packages depend on the new systemtap (sub) and recompiling them with probe points enabled, users of those packages will be able to trace any high level events that these packages provide.
Benefit to Fedora
It will be easier for developers and users to observe what is really happening on their system on a higher (application) level.
Scope
- Work with upstream to identify any issues with the new capabilities while we activate probes in packages.
- Package new version of Systemtap (including new subpackage systemtap-sdt-devel).
- Identify packages that already include static user probes (postgresql, java-1.6.0-openjdk, mysql, xorg-x11-server, ...)
- Work with package maintainer to enable them in the Fedora build spec file.
- Add documentation on enabled probes and how to use them with a systemtap tapset.
How To Test
Needs to be expanded
- Need a specific pacakage list.
- For each package enabling probes a reference to the probe names.
- And an simple example stap invocation listing markers that can be enabled.
User Experience
For packages that have static probes enabled users will be able to trace high-level events, like for example database transactions, through stap.
Dependencies
- A new version of systemtap with the systemtap-sdt-devel subpackage.
- Any package wishing to expose existing probes in its (upstream) sources depending on systemtap-sdt-devel and adding an --enable-dtrace or equivalent to its spec file.
- Not required for this feature, but since systemtap uses debuginfo, this feature is enhanced by the Debug Info Revamp Feature.
Contingency Plan
Even if all the tracing will not work, packages that are converted to provide static probes will not be impacted since the probe points have (near) zero overhead, so in the worse case some packages were recompiled to enable the feature, but users will still not be able to use it.
Documentation
The upstream wiki is the best description for now http://sourceware.org/systemtap/wiki/UsingStaticUserMarkers the systemtap list has an example on converting a package http://sourceware.org/ml/systemtap/2009-q1/msg00140.html
While working on this feature this section will be expanded to list packages that have probe points enabled and pointers to (upstream) package documentation on the probe names and semantics like for postgresql http://www.postgresql.org/docs/8.2/static/dynamic-trace.html
Release Notes
- FIXME: Should have some notes about the feature and which packages were enabled when finished.
Comments and Discussion