From bfc92a838eaf27bc785b547d684b4d01c8edb2f3 Mon Sep 17 00:00:00 2001 From: Anton Patsev Date: Sun, 13 Oct 2024 07:46:18 +0600 Subject: [PATCH] feat: init --- .github/workflows/main.yml | 99 ++++++++++++++++++ Dockerfile | 23 +++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++ README.md | 25 +++++ go.mod | 10 ++ go.sum | 22 ++++ golang-example-dsn.yaml | 7 ++ golang-example.yaml | 26 +++++ main.go | 125 +++++++++++++++++++++++ 9 files changed, 538 insertions(+) create mode 100644 .github/workflows/main.yml create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 go.mod create mode 100644 go.sum create mode 100644 golang-example-dsn.yaml create mode 100644 golang-example.yaml create mode 100644 main.go diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..f3a2c95 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,99 @@ +name: Create and publish a Docker image + +on: + push: + branches: + - main + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build-and-push-image: + runs-on: ubuntu-latest + + permissions: + contents: write + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4.2.1 + + - name: Get Next Semver Version + id: semver + uses: ietf-tools/semver-action@v1.8.0 + with: + token: ${{ github.token }} + branch: main + noVersionBumpBehavior: warn + + - name: Create Tag + uses: rickstaa/action-create-tag@v1.7.2 + if: ${{ steps.semver.outputs.nextStrict != '' }} + with: + tag: ${{ steps.semver.outputs.nextStrict }} + tag_exists_error: false + message: "Automatic tag ${{ steps.semver.outputs.nextStrict }}" + + - name: Update CHANGELOG + id: changelog + uses: requarks/changelog-action@v1.10.2 + if: ${{ steps.semver.outputs.nextStrict != '' }} + with: + token: ${{ github.token }} + fromTag: ${{ steps.semver.outputs.nextStrict }} + toTag: ${{ steps.semver.outputs.current }} + excludeTypes: "chore,ci,docs,style,test,release" + + - name: Create Release + uses: ncipollo/release-action@v1.14.0 + id: release + if: ${{ steps.semver.outputs.nextStrict != '' }} + with: + allowUpdates: true + draft: false + makeLatest: true + name: ${{ steps.semver.outputs.nextStrict }} + tag: ${{ steps.semver.outputs.nextStrict }} + body: ${{ steps.changelog.outputs.changes }} + token: ${{ github.token }} + + - name: Commit CHANGELOG.md + uses: stefanzweifel/git-auto-commit-action@v5.0.1 + if: ${{ steps.semver.outputs.nextStrict != '' }} + with: + branch: main + commit_message: "release: changelog for ${{ steps.semver.outputs.nextStrict }} [skip ci]" + file_pattern: CHANGELOG.md + + # Workaround: https://github.com/docker/build-push-action/issues/461 + - name: Setup Docker buildx + uses: docker/setup-buildx-action@v3.7.1 + + - name: Log in to the Container registry + uses: docker/login-action@v3.3.0 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ github.token }} + + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@v5.5.1 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + + - name: Build and push Docker image + id: push + uses: docker/build-push-action@v6.9.0 + with: + context: . + platforms: linux/amd64,linux/arm64 + push: true + tags: | + ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.semver.outputs.nextStrict }} + ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest + labels: ${{ steps.meta.outputs.labels }} + annotations: ${{ steps.meta.outputs.annotations }} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..3288485 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,23 @@ +# Use the official Go image +FROM golang:1.21-alpine + +# Install the working directory +WORKDIR /app + +# Copy go.mod and go.sum +COPY go.mod go.sum ./ + +# Download dependencies +RUN go mod download + +# Copy the source code +COPY . . . + +# Build the application +RUN go build -o main . + +# Specify the port to be used by the container +EXPOSE 8080 + +# Run the application +CMD [“./main”] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d045317 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +Creating kubernetes secret: + +Replace your-base64-encoded-sentry-dsn with your base64 encoded DSN: +``` +echo -n “your-sentry-dsn” | base64 -w0 +``` + +Apply secret: +``` +kubectl apply -f golang-example-dsn.yaml +``` + +Change version in image and apply deployment: +``` +kubectl apply -f golang-example.yaml +``` + +Notes: +Make sure you replace “your-sentry-dsn” with your real DSN. + +Make sure you have access to your Kubernetes cluster configured and kubectl installed. + +This code and instructions will allow you to generate a large number of different exceptions and send them to Sentry for benchmarking, and deploy this process to Kubernetes. + + diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..d1439e7 --- /dev/null +++ b/go.mod @@ -0,0 +1,10 @@ +module sentry-benchmark + +go 1.21 + +require github.com/getsentry/sentry-go v0.28.1 + +require ( + golang.org/x/sys v0.18.0 // indirect + golang.org/x/text v0.14.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..ec6d279 --- /dev/null +++ b/go.sum @@ -0,0 +1,22 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/getsentry/sentry-go v0.28.1 h1:zzaSm/vHmGllRM6Tpx1492r0YDzauArdBfkJRtY6P5k= +github.com/getsentry/sentry-go v0.28.1/go.mod h1:1fQZ+7l7eeJ3wYi82q5Hg8GqAPgefRq+FP/QhafYVgg= +github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA= +github.com/go-errors/errors v1.4.2/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3BopGUQ5a5Og= +github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= +github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/pingcap/errors v0.11.4 h1:lFuQV/oaUMGcD2tqt+01ROSmJs75VG1ToEOkZIZ4nE4= +github.com/pingcap/errors v0.11.4/go.mod h1:Oi8TUi2kEtXXLMJk9l1cGmz20kV3TaQ0usTwv5KuLY8= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= +github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4= +golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/golang-example-dsn.yaml b/golang-example-dsn.yaml new file mode 100644 index 0000000..9e2802d --- /dev/null +++ b/golang-example-dsn.yaml @@ -0,0 +1,7 @@ +apiVersion: v1 +kind: Secret +metadata: + name: golang-example-dsn +type: Opaque +data: + dsn: xxxxxxxxxxxxxxxxxxxxxxx diff --git a/golang-example.yaml b/golang-example.yaml new file mode 100644 index 0000000..be2300a --- /dev/null +++ b/golang-example.yaml @@ -0,0 +1,26 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: golang-example +spec: + replicas: 1 + selector: + matchLabels: + app: golang-example + template: + metadata: + labels: + app: golang-example + spec: + containers: + - name: golang-example + image: sentry-kubernetes/golang-test-image:1.0.0 + imagePullPolicy: Always + env: + - name: SENTRY_DSN + valueFrom: + secretKeyRef: + name: golang-example-dsn + key: dsn + ports: + - containerPort: 8080 diff --git a/main.go b/main.go new file mode 100644 index 0000000..970530f --- /dev/null +++ b/main.go @@ -0,0 +1,125 @@ +package main + +import ( + "fmt" + "log" + "math/rand" + "os" + "time" + + "github.com/getsentry/sentry-go" +) + +func main() { + // Initializing Sentry with DSN from environment variables + dsn := os.Getenv("SENTRY_DSN") + if dsn == "" { + log.Fatal("SENTRY_DSN environment variable is required") + } + + err := sentry.Init(sentry.ClientOptions{ + Dsn: dsn, + TracesSampleRate: 1.0, + }) + if err != nil { + log.Fatalf("sentry.Init: %s", err) + } + defer sentry.Flush(2 * time.Second) + + // Initialization of the random number generator + rand.Seed(time.Now().UnixNano()) + + // Infinite loop for generating and sending different types of errors + for { + var err error + switch rand.Intn(8) { + case 0: + err = &newCustomError{message: fmt.Sprintf("new custom error: %d", rand.Intn(1000))} + case 1: + err = &anotherNewCustomError{message: fmt.Sprintf("another new custom error: %d", rand.Intn(1000))} + case 2: + err = &yetAnotherNewCustomError{message: fmt.Sprintf("yet another new custom error: %d", rand.Intn(1000))} + case 3: + err = &complexNewCustomError{code: rand.Intn(100), message: fmt.Sprintf("complex new custom error: %d", rand.Intn(1000))} + case 4: + err = &yetAnotherComplexCustomError{code: rand.Intn(100), message: fmt.Sprintf("yet another complex custom error: %d", rand.Intn(1000))} + case 5: + err = &evenMoreComplexCustomError{code: rand.Intn(100), message: fmt.Sprintf("even more complex custom error: %d", rand.Intn(1000))} + case 6: + err = &simpleCustomError{message: fmt.Sprintf("simple custom error: %d", rand.Intn(1000))} + case 7: + err = &anotherSimpleCustomError{message: fmt.Sprintf("another simple custom error: %d", rand.Intn(1000))} + } + + sentry.CaptureException(err) + log.Printf("Sent error: %v to Sentry", err) + time.Sleep(100 * time.Millisecond) // Delay to simulate real load + } +} + +type newCustomError struct { + message string +} + +func (e *newCustomError) Error() string { + return e.message +} + +type anotherNewCustomError struct { + message string +} + +func (e *anotherNewCustomError) Error() string { + return e.message +} + +type yetAnotherNewCustomError struct { + message string +} + +func (e *yetAnotherNewCustomError) Error() string { + return e.message +} + +type complexNewCustomError struct { + code int + message string +} + +func (e *complexNewCustomError) Error() string { + return fmt.Sprintf("code: %d, message: %s", e.code, e.message) +} + +type yetAnotherComplexCustomError struct { + code int + message string +} + +func (e *yetAnotherComplexCustomError) Error() string { + return fmt.Sprintf("code: %d, message: %s", e.code, e.message) +} + +type evenMoreComplexCustomError struct { + code int + message string +} + +func (e *evenMoreComplexCustomError) Error() string { + return fmt.Sprintf("code: %d, message: %s", e.code, e.message) +} + +type simpleCustomError struct { + message string +} + +func (e *simpleCustomError) Error() string { + return e.message +} + +type anotherSimpleCustomError struct { + message string +} + +func (e *anotherSimpleCustomError) Error() string { + return e.message +}