├── .gitignore
├── CHANGELOG.md
├── Cargo.toml
├── .github
└── workflows
│ ├── release.yml
│ └── general.yml
├── LICENSE-MIT
├── README.md
├── src
└── lib.rs
└── LICENSE-APACHE
/.gitignore:
--------------------------------------------------------------------------------
1 | /target
2 | /Cargo.lock
3 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 | All notable changes to this project will be documented in this file.
3 |
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6 |
7 | ## [Unreleased]
8 |
9 | ## [0.1.1](https://github.com/LukeMathWalker/tracing-panic/compare/v0.1.0...v0.1.1) - 2023-05-22
10 |
11 | ### Other
12 | - Add note about preserving the previous panic hook (#2)
13 | - Fix clippy and formatting
14 |
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "tracing-panic"
3 | version = "0.1.2"
4 | edition = "2021"
5 | license = "MIT/Apache-2.0"
6 | repository = "https://github.com/LukeMathWalker/tracing-panic"
7 | description = "A panic hook that captures panic information as a tracing event"
8 | keywords = ["logging", "tracing", "panic", "telemetry", "hook"]
9 | categories = ["development-tools::debugging"]
10 |
11 | [features]
12 | default = ["capture-backtrace"]
13 | capture-backtrace = []
14 |
15 | [dependencies]
16 | tracing = "0.1"
17 | tracing-subscriber = "0.3"
18 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: Release-plz
2 |
3 | permissions:
4 | pull-requests: write
5 | contents: write
6 |
7 | on:
8 | push:
9 | branches:
10 | - main
11 |
12 | jobs:
13 | release-plz:
14 | name: Release-plz
15 | runs-on: ubuntu-latest
16 | steps:
17 | - name: Checkout repository
18 | uses: actions/checkout@v3
19 | with:
20 | fetch-depth: 0
21 | - name: Install Rust toolchain
22 | uses: dtolnay/rust-toolchain@stable
23 | - name: Run release-plz
24 | uses: MarcoIeni/release-plz-action@v0.5
25 | env:
26 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27 | CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
28 |
--------------------------------------------------------------------------------
/LICENSE-MIT:
--------------------------------------------------------------------------------
1 | Permission is hereby granted, free of charge, to any
2 | person obtaining a copy of this software and associated
3 | documentation files (the "Software"), to deal in the
4 | Software without restriction, including without
5 | limitation the rights to use, copy, modify, merge,
6 | publish, distribute, sublicense, and/or sell copies of
7 | the Software, and to permit persons to whom the Software
8 | is furnished to do so, subject to the following
9 | conditions:
10 |
11 | The above copyright notice and this permission notice
12 | shall be included in all copies or substantial portions
13 | of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 | DEALINGS IN THE SOFTWARE.
24 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | tracing-panic
2 |
3 |
4 | Make panics visible in your telemetry pipeline.
5 |
6 |
7 |
8 |
9 |
10 |
27 |
28 |
29 | `tracing-panic` provides a custom panic hook to emit an error-level `tracing` event when a panic occurs.
30 | Check out the docs for more details!
31 |
32 | ## License
33 |
34 | Licensed under either of Apache License, Version 2.0 or MIT license at your option.
35 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
--------------------------------------------------------------------------------
/.github/workflows/general.yml:
--------------------------------------------------------------------------------
1 | name: Rust
2 |
3 | on:
4 | push:
5 | branches:
6 | - main
7 | pull_request:
8 | types: [ opened, synchronize, reopened ]
9 | branches:
10 | - main
11 |
12 | env:
13 | CARGO_TERM_COLOR: always
14 |
15 | jobs:
16 | test:
17 | name: Test
18 | runs-on: ubuntu-latest
19 | steps:
20 | - name: Check out repository code
21 | uses: actions/checkout@v3
22 | - name: Install the Rust toolchain
23 | uses: dtolnay/rust-toolchain@stable
24 | - name: Rust Cache Action
25 | uses: Swatinem/rust-cache@v2
26 | - name: Run tests (no-default-features)
27 | run: cargo test --no-default-features
28 | - name: Run tests (with default features)
29 | run: cargo test
30 |
31 | fmt:
32 | name: Rustfmt
33 | runs-on: ubuntu-latest
34 | steps:
35 | - uses: actions/checkout@v3
36 | - uses: dtolnay/rust-toolchain@stable
37 | with:
38 | components: rustfmt
39 | - name: Enforce formatting
40 | run: cargo fmt --check
41 |
42 | clippy:
43 | name: Clippy
44 | runs-on: ubuntu-latest
45 | steps:
46 | - uses: actions/checkout@v3
47 | - uses: dtolnay/rust-toolchain@stable
48 | with:
49 | components: clippy
50 | - uses: Swatinem/rust-cache@v2
51 | - name: Linting (no-default-features)
52 | run: cargo clippy --no-default-features -- -D warnings
53 | - name: Linting (with default features)
54 | run: cargo clippy -- -D warnings
55 |
--------------------------------------------------------------------------------
/src/lib.rs:
--------------------------------------------------------------------------------
1 | //! A panic hook that emits an error-level `tracing` event when a panic occurs.
2 | //!
3 | //! Check out [`panic_hook`]'s documentation for more information.
4 | use std::{
5 | backtrace::{Backtrace, BacktraceStatus},
6 | panic::PanicInfo,
7 | };
8 |
9 | /// A panic hook that emits an error-level `tracing` event when a panic occurs.
10 | ///
11 | /// The default panic hook prints the panic information to stderr, which might or
12 | /// might not be picked up by your telemetry system.
13 | ///
14 | /// This hook, instead, makes sure that panic information goes through the `tracing`
15 | /// pipeline you've configured.
16 | ///
17 | /// # Usage
18 | ///
19 | /// ```rust
20 | /// use tracing_panic::panic_hook;
21 | ///
22 | /// # #[allow(clippy::needless_doctest_main)]
23 | /// fn main() {
24 | /// // Initialize your `tracing` subscriber however you like.
25 | /// // [...]
26 | /// // Then set the panic hook.
27 | /// // This should be done only once, at the beginning of your program.
28 | /// std::panic::set_hook(Box::new(panic_hook));
29 | /// }
30 | /// ```
31 | ///
32 | /// # Backtrace
33 | ///
34 | /// If the `capture-backtrace` feature flag is enabled, `tracing-panic` will try to
35 | /// capture a backtrace.
36 | /// Whether a backtrace is actually captured depends on the value of a few
37 | /// environment variables, defined in Rust's standard library.
38 | /// Check out [`std`'s documentation](https://doc.rust-lang.org/std/backtrace/#environment-variables)
39 | /// for more details.
40 | ///
41 | /// # Preserving previous hook
42 | ///
43 | /// Sometimes it's desirable to preserve the previous panic hook, because other crates
44 | /// might rely on their panic hook integration to function properly.
45 | ///
46 | /// For this behavior, you can do the following:
47 | ///
48 | /// ```rust
49 | /// use tracing_panic::panic_hook;
50 | ///
51 | /// # #[allow(clippy::needless_doctest_main)]
52 | /// fn main() {
53 | /// let prev_hook = std::panic::take_hook();
54 | /// std::panic::set_hook(Box::new(move |panic_info| {
55 | /// panic_hook(panic_info);
56 | /// prev_hook(panic_info);
57 | /// }));
58 | /// }
59 | /// ```
60 | pub fn panic_hook(panic_info: &PanicInfo) {
61 | let payload = panic_info.payload();
62 |
63 | #[allow(clippy::manual_map)]
64 | let payload = if let Some(s) = payload.downcast_ref::<&str>() {
65 | Some(&**s)
66 | } else if let Some(s) = payload.downcast_ref::() {
67 | Some(s.as_str())
68 | } else {
69 | None
70 | };
71 |
72 | let location = panic_info.location().map(|l| l.to_string());
73 | let (backtrace, note) = if cfg!(feature = "capture-backtrace") {
74 | let backtrace = Backtrace::capture();
75 | let note = (backtrace.status() == BacktraceStatus::Disabled)
76 | .then_some("run with RUST_BACKTRACE=1 environment variable to display a backtrace");
77 | (Some(backtrace), note)
78 | } else {
79 | (None, None)
80 | };
81 |
82 | tracing::error!(
83 | panic.payload = payload,
84 | panic.location = location,
85 | panic.backtrace = backtrace.map(tracing::field::display),
86 | panic.note = note,
87 | "A panic occurred",
88 | );
89 | }
90 |
91 | #[cfg(test)]
92 | mod tests {
93 | use tracing::subscriber::DefaultGuard;
94 |
95 | use super::panic_hook;
96 | use std::io;
97 | use std::sync::{Arc, Mutex, MutexGuard, TryLockError};
98 |
99 | #[test]
100 | fn test_static_panic_message() {
101 | let buffer = Arc::new(Mutex::new(vec![]));
102 | let _guard = init_subscriber(buffer.clone());
103 | let _ = std::panic::catch_unwind(|| {
104 | std::panic::set_hook(Box::new(panic_hook));
105 | panic!("This is a static panic message");
106 | });
107 |
108 | let logs = String::from_utf8(buffer.lock().unwrap().clone()).unwrap();
109 | assert!(logs.contains("This is a static panic message"));
110 | }
111 |
112 | #[cfg(feature = "capture-backtrace")]
113 | #[test]
114 | fn panic_has_backtrace() {
115 | let buffer = Arc::new(Mutex::new(vec![]));
116 | let _guard = init_subscriber(buffer.clone());
117 | let _ = std::panic::catch_unwind(|| {
118 | std::panic::set_hook(Box::new(panic_hook));
119 | panic!("This is a static panic message");
120 | });
121 |
122 | let logs = String::from_utf8(buffer.lock().unwrap().clone()).unwrap();
123 | assert!(logs.contains("backtrace"));
124 | }
125 |
126 | #[cfg(not(feature = "capture-backtrace"))]
127 | #[test]
128 | fn panic_has_no_backtrace() {
129 | let buffer = Arc::new(Mutex::new(vec![]));
130 | let _guard = init_subscriber(buffer.clone());
131 | let _ = std::panic::catch_unwind(|| {
132 | std::panic::set_hook(Box::new(panic_hook));
133 | panic!("This is a static panic message");
134 | });
135 |
136 | let logs = String::from_utf8(buffer.lock().unwrap().clone()).unwrap();
137 | assert!(!logs.contains("backtrace"));
138 | }
139 |
140 | #[test]
141 | fn test_interpolated_panic_message() {
142 | let buffer = Arc::new(Mutex::new(vec![]));
143 | let _guard = init_subscriber(buffer.clone());
144 |
145 | let _ = std::panic::catch_unwind(|| {
146 | std::panic::set_hook(Box::new(panic_hook));
147 | panic!("This is an {} panic message", "interpolated");
148 | });
149 |
150 | let logs = String::from_utf8(buffer.lock().unwrap().clone()).unwrap();
151 | assert!(logs.contains("This is an interpolated panic message"));
152 | }
153 |
154 | fn init_subscriber(buffer: Arc>>) -> DefaultGuard {
155 | let subscriber = tracing_subscriber::fmt()
156 | .with_writer(move || MockWriter::new(buffer.clone()))
157 | .finish();
158 | tracing::subscriber::set_default(subscriber)
159 | }
160 |
161 | /// Use a vector of bytes behind a Arc as writer in order to inspect the tracing output
162 | /// for testing purposes.
163 | pub struct MockWriter {
164 | buf: Arc>>,
165 | }
166 |
167 | impl MockWriter {
168 | pub fn new(buf: Arc>>) -> Self {
169 | Self { buf }
170 | }
171 |
172 | pub fn map_error(err: TryLockError) -> io::Error {
173 | match err {
174 | TryLockError::WouldBlock => io::Error::from(io::ErrorKind::WouldBlock),
175 | TryLockError::Poisoned(_) => io::Error::from(io::ErrorKind::Other),
176 | }
177 | }
178 |
179 | pub fn buf(&self) -> io::Result>> {
180 | self.buf.try_lock().map_err(Self::map_error)
181 | }
182 | }
183 |
184 | impl io::Write for MockWriter {
185 | fn write(&mut self, buf: &[u8]) -> io::Result {
186 | self.buf()?.write(buf)
187 | }
188 |
189 | fn flush(&mut self) -> io::Result<()> {
190 | self.buf()?.flush()
191 | }
192 | }
193 | }
194 |
--------------------------------------------------------------------------------
/LICENSE-APACHE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
15 |
16 |
17 |
18 | 
20 |
21 |
22 |
23 | 
25 |
26 |