├── .gitignore ├── LICENSE_APACHE ├── LICENSE_MIT ├── README.md ├── index.js ├── package-lock.json ├── package.json └── sentry.js /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | Cargo.lock 4 | bin/ 5 | pkg/ 6 | wasm-pack.log 7 | worker/ 8 | node_modules/ 9 | .cargo-ok 10 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /LICENSE_MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2019 Michael Hart and Bustle Digital Group 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cf-sentry 2 | 3 | A template to create a [Cloudflare worker](https://www.cloudflare.com/products/cloudflare-workers/) 4 | that logs errors to [Sentry](https://sentry.io). 5 | 6 | ## Generating 7 | 8 | Use [wrangler](https://github.com/cloudflare/wrangler) 9 | 10 | ``` 11 | wrangler generate projectname https://github.com/bustle/cf-sentry 12 | ``` 13 | 14 | Then edit the config variables in [`sentry.js`](https://github.com/bustle/cf-sentry/blob/master/sentry.js) 15 | to suit your environment: 16 | 17 | ```js 18 | // Get the key from the "DSN" at: https://sentry.io/settings//projects//keys/ 19 | // The "DSN" will be in the form: https://@sentry.io/ 20 | // eg, https://0000aaaa1111bbbb2222cccc3333dddd@sentry.io/123456 21 | const SENTRY_PROJECT_ID = '123456' 22 | const SENTRY_KEY = '0000aaaa1111bbbb2222cccc3333dddd' 23 | 24 | // Useful if you have multiple apps within a project – not necessary, only used in TAGS and SERVER_NAME below 25 | const APP = 'my-app' 26 | 27 | // https://docs.sentry.io/error-reporting/configuration/?platform=javascript#environment 28 | const ENV = 'development' 29 | 30 | // https://docs.sentry.io/error-reporting/configuration/?platform=javascript#release 31 | // A string describing the version of the release – we just use: git rev-parse --verify HEAD 32 | // You can use this to associate files/source-maps: https://docs.sentry.io/cli/releases/#upload-files 33 | const RELEASE = '0000aaaa1111bbbb2222cccc3333dddd' 34 | 35 | // https://docs.sentry.io/enriching-error-data/context/?platform=javascript#tagging-events 36 | const TAGS = { app: APP } 37 | 38 | // https://docs.sentry.io/error-reporting/configuration/?platform=javascript#server-name 39 | const SERVER_NAME = `${APP}-${ENV}` 40 | ``` 41 | 42 | Then you can build your project, publish it, etc with `wrangler`: 43 | ``` 44 | cd projectname 45 | wrangler build 46 | ``` 47 | 48 | ## License 49 | 50 | Licensed under either of 51 | 52 | - Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 53 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 54 | 55 | at your option. 56 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import { log } from './sentry' 2 | 3 | addEventListener('fetch', event => { 4 | event.respondWith(handleEvent(event)) 5 | }) 6 | 7 | async function handleEvent(event) { 8 | try { 9 | const res = await handleRequest(event.request) 10 | return res 11 | } catch (e) { 12 | event.waitUntil(log(e, event.request)) 13 | return new Response(e.message || 'An error occurred!', { status: e.statusCode || 500 }) 14 | } 15 | } 16 | 17 | async function handleRequest(request) { 18 | // To test: 19 | // throw new Error('Oh no!') 20 | return new Response('Hello worker!', { status: 200 }) 21 | } 22 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "{{ project-name }}", 3 | "version": "1.0.2", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "prettier": { 8 | "version": "1.18.2", 9 | "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.18.2.tgz", 10 | "integrity": "sha512-OeHeMc0JhFE9idD4ZdtNibzY0+TPHSpSSb9h8FqtP+YnoZZ1sl8Vc9b1sasjfymH3SonAF4QcA2+mzHPhMvIiw==", 11 | "dev": true 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "{{ project-name }}", 3 | "version": "1.0.2", 4 | "description": "A template to create a Cloudflare worker that logs errors to Sentry", 5 | "main": "index.js", 6 | "scripts": { 7 | "format": "prettier --write --no-semi --single-quote --print-width 100 --trailing-comma es5 '**/*.{js,css,json,md}'" 8 | }, 9 | "author": "{{ authors }}", 10 | "license": "MIT", 11 | "devDependencies": { 12 | "prettier": "^1.18.2" 13 | }, 14 | "dependencies": {} 15 | } 16 | -------------------------------------------------------------------------------- /sentry.js: -------------------------------------------------------------------------------- 1 | // Get the key from the "DSN" at: https://sentry.io/settings//projects//keys/ 2 | // The "DSN" will be in the form: https://@sentry.io/ 3 | // eg, https://0000aaaa1111bbbb2222cccc3333dddd@sentry.io/123456 4 | const SENTRY_PROJECT_ID = '123456' 5 | const SENTRY_KEY = '0000aaaa1111bbbb2222cccc3333dddd' 6 | 7 | // Useful if you have multiple apps within a project – not necessary, only used in TAGS and SERVER_NAME below 8 | const APP = 'my-app' 9 | 10 | // https://docs.sentry.io/error-reporting/configuration/?platform=javascript#environment 11 | const ENV = 'development' 12 | 13 | // https://docs.sentry.io/error-reporting/configuration/?platform=javascript#release 14 | // A string describing the version of the release – we just use: git rev-parse --verify HEAD 15 | // You can use this to associate files/source-maps: https://docs.sentry.io/cli/releases/#upload-files 16 | const RELEASE = '0000aaaa1111bbbb2222cccc3333dddd' 17 | 18 | // https://docs.sentry.io/enriching-error-data/context/?platform=javascript#tagging-events 19 | const TAGS = { app: APP } 20 | 21 | // https://docs.sentry.io/error-reporting/configuration/?platform=javascript#server-name 22 | const SERVER_NAME = `${APP}-${ENV}` 23 | 24 | // Indicates the name of the SDK client 25 | const CLIENT_NAME = 'bustle-cf-sentry' 26 | const CLIENT_VERSION = '1.0.0' 27 | const RETRIES = 5 28 | 29 | // The log() function takes an Error object and the current request 30 | // 31 | // Eg, from a worker: 32 | // 33 | // addEventListener('fetch', event => { 34 | // event.respondWith(async () => { 35 | // try { 36 | // throw new Error('Oh no!') 37 | // } catch (e) { 38 | // await log(e, event.request) 39 | // } 40 | // return new Response('Logged!') 41 | // }) 42 | // }) 43 | 44 | export async function log(err, request) { 45 | const body = JSON.stringify(toSentryEvent(err, request)) 46 | 47 | for (let i = 0; i <= RETRIES; i++) { 48 | const res = await fetch(`https://sentry.io/api/${SENTRY_PROJECT_ID}/store/`, { 49 | method: 'POST', 50 | headers: { 51 | 'Content-Type': 'application/json', 52 | 'X-Sentry-Auth': [ 53 | 'Sentry sentry_version=7', 54 | `sentry_client=${CLIENT_NAME}/${CLIENT_VERSION}`, 55 | `sentry_key=${SENTRY_KEY}`, 56 | ].join(', '), 57 | }, 58 | body, 59 | }) 60 | if (res.status === 200) { 61 | return 62 | } 63 | // We couldn't send to Sentry, try to log the response at least 64 | console.error({ httpStatus: res.status, ...(await res.json()) }) // eslint-disable-line no-console 65 | } 66 | } 67 | 68 | function toSentryEvent(err, request) { 69 | const errType = err.name || (err.contructor || {}).name 70 | const frames = parse(err) 71 | const extraKeys = Object.keys(err).filter(key => !['name', 'message', 'stack'].includes(key)) 72 | return { 73 | event_id: uuidv4(), 74 | message: errType + ': ' + (err.message || ''), 75 | exception: { 76 | values: [ 77 | { 78 | type: errType, 79 | value: err.message, 80 | stacktrace: frames.length ? { frames: frames.reverse() } : undefined, 81 | }, 82 | ], 83 | }, 84 | extra: extraKeys.length 85 | ? { 86 | [errType]: extraKeys.reduce((obj, key) => ({ ...obj, [key]: err[key] }), {}), 87 | } 88 | : undefined, 89 | tags: TAGS, 90 | platform: 'javascript', 91 | environment: ENV, 92 | server_name: SERVER_NAME, 93 | timestamp: Date.now() / 1000, 94 | request: 95 | request && request.url 96 | ? { 97 | method: request.method, 98 | url: request.url, 99 | query_string: request.query, 100 | headers: request.headers, 101 | data: request.body, 102 | } 103 | : undefined, 104 | release: RELEASE, 105 | } 106 | } 107 | 108 | function parse(err) { 109 | return (err.stack || '') 110 | .split('\n') 111 | .slice(1) 112 | .map(line => { 113 | if (line.match(/^\s*[-]{4,}$/)) { 114 | return { filename: line } 115 | } 116 | 117 | // From https://github.com/felixge/node-stack-trace/blob/1ec9ba43eece124526c273c917104b4226898932/lib/stack-trace.js#L42 118 | const lineMatch = line.match(/at (?:(.+)\s+\()?(?:(.+?):(\d+)(?::(\d+))?|([^)]+))\)?/) 119 | if (!lineMatch) { 120 | return 121 | } 122 | 123 | return { 124 | function: lineMatch[1] || undefined, 125 | filename: lineMatch[2] || undefined, 126 | lineno: +lineMatch[3] || undefined, 127 | colno: +lineMatch[4] || undefined, 128 | in_app: lineMatch[5] !== 'native' || undefined, 129 | } 130 | }) 131 | .filter(Boolean) 132 | } 133 | 134 | function uuidv4() { 135 | const bytes = new Uint8Array(16) 136 | crypto.getRandomValues(bytes) 137 | bytes[6] = (bytes[6] & 0x0f) | 0x40 138 | bytes[8] = (bytes[8] & 0x3f) | 0x80 139 | return [...bytes].map(b => ('0' + b.toString(16)).slice(-2)).join('') // to hex 140 | } 141 | --------------------------------------------------------------------------------