diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..de4e957 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,14 @@ +* @signalfx/gdi-go-maintainers @signalfx/gdi-go-approvers + +CODEOWNERS @signalfx/gdi-go-maintainers + +##################################################### +# +# Docs reviewers +# +##################################################### + +*.md @signalfx/gdi-docs @signalfx/gdi-go-maintainers @signalfx/gdi-go-approvers +*.rst @signalfx/gdi-docs @signalfx/gdi-go-maintainers @signalfx/gdi-go-approvers +docs/ @signalfx/gdi-docs @signalfx/gdi-go-maintainers @signalfx/gdi-go-approvers +README* @signalfx/gdi-docs @signalfx/gdi-go-maintainers @signalfx/gdi-go-approvers diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c048eae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Report an issue to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the issue** +A clear and concise description of what the issue is. + +**Steps to reproduce the issue:** +For example: + +1. Use this code '...' +2. Run '...' +3. See error + +**Attempted solutions and workarounds** +Describe what you've tried to solve the issue or any workarounds you've found. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment** +Complete the following information: + +- OS version: [for example: iOS Big Sur or Windows 11] +- Go version: [for example, 1.6] +- signalflow-client-go version: [for example, 1295520, v0.1.0] + +**Additional context** +Add additional information about the issue, like debug logs or screenshots. +Redact or remove any sensitive information before sharing this information. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6e9b8c4 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# File generated by "make gendependabot"; DO NOT EDIT. + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + - package-ecosystem: "gomod" + directory: "/" + schedule: + interval: "weekly" + diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..9b57c1d --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,31 @@ +name: ci + +on: + push: + branches: [ main ] + pull_request: + workflow_dispatch: + +jobs: + check-links: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v4.1.2 + - uses: lycheeverse/lychee-action@v1.9.3 + with: + fail: true + + compatibility-test: + strategy: + matrix: + go-version: + - '1.21' + - '1.22' + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v4.1.2 + - uses: actions/setup-go@v5.0.0 + with: + go-version: ${{ matrix.go-version }} + check-latest: true + - run: go test -race ./... diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml new file mode 100644 index 0000000..6692e00 --- /dev/null +++ b/.github/workflows/cla.yml @@ -0,0 +1,30 @@ +name: "CLA Assistant" +on: + issue_comment: + types: [created] + pull_request_target: + types: [opened, closed, synchronize] + +permissions: + actions: write + contents: read + pull-requests: write + statuses: write + +jobs: + ContributorLicenseAgreement: + runs-on: ubuntu-latest + steps: + - name: "CLA Assistant" + if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' + uses: cla-assistant/github-action@v2.3.2 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PERSONAL_ACCESS_TOKEN: ${{ secrets.PAT_CLATOOL }} + with: + remote-organization-name: splunk + remote-repository-name: cla-agreement + branch: main + path-to-signatures: signatures/version1/cla.json + path-to-document: https://github.com/splunk/cla-agreement/blob/main/CLA.md + allowlist: dependabot[bot],renovate[bot] diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 0000000..123049e --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,2 @@ +# TODO: Remove after making the repository public. +https://pkg.go.dev/github.com/signalfx/signalflow-client-go/signalflow diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d23cfa3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# Changelog + +All notable changes to this library are documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). + +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..072da1e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,90 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances + of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others’ private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Project maintainers are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for +moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail +address, posting via an official social media account, or acting as an +appointed representative at an online or offline event. Representation of a +project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at . All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +at [https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b9a318d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,91 @@ +# Contributing Guidelines + +Thank you for your interest in contributing to our repository! Whether it's a bug +report, new feature, or question, we greatly value feedback and contributions from +our community. Read through this document before submitting any issues or pull +requests to ensure we have all the necessary information to effectively respond +to your bug report or contribution. + +In addition to this document, review our [Code of Conduct](CODE_OF_CONDUCT.md). +For any code of conduct questions or comments, send an email to . + +## Reporting Bugs/Feature Requests + +We welcome you to use the GitHub issue tracker to report bugs or suggest +features. When filing an issue, check existing open, or recently closed, +issues to make sure somebody else hasn't already reported the issue. Try +to include as much information as you can. Details like these can be useful: + +- A reproducible test case or series of steps +- The version of our code being used +- Any modifications you've made relevant to the bug +- Anything unusual about your environment or deployment +- Any known workarounds + +When filing an issue, do *NOT* include: + +- Internal identifiers such as Jira tickets +- Any sensitive information related to your environment, users, etc. + +## Reporting Security Issues + +See [SECURITY.md](SECURITY.md#reporting-security-issues) for instructions. + +## Documentation + +The Splunk Observability documentation is hosted on the [Splunk Observability +Cloud docs site](https://docs.splunk.com/Observability), which contains all the +prescriptive guidance for Splunk Observability products. Prescriptive guidance +consists of step-by-step instructions, conceptual material, and decision support +for customers. Reference documentation and development documentation is still +hosted on this repository. + +To contribute documentation for this project, open a pull request in the +[public-o11y-docs](https://github.com/splunk/public-o11y-docs) repository. See +the [CONTRIBUTING.md](https://github.com/splunk/public-o11y-docs/blob/main/CONTRIBUTING.md) +guide of the Splunk Observability Cloud documentation for more information. + +## Contributing via Pull Requests + +Contributions via Pull Requests (PRs) are much appreciated. Before sending us a +pull request, make sure that: + +1. You are working against the latest source on the `main` branch. +2. You check existing open, and recently merged, pull requests to make sure + someone else hasn't addressed the problem already. +3. You open an issue to discuss any significant work - we would hate for your + time to be wasted. +4. You submit PRs that are easy to review and ideally less 500 lines of code. + Multiple PRs can be submitted for larger contributions. + +To send us a pull request: + +1. Fork the repository. +2. Modify the source; a single change per PR is recommended. If you also + reformat all the code, it will be hard for us to focus on your change. +3. Ensure local tests pass and add new tests related to the contribution. +4. Commit to your fork using clear commit messages. +5. [Sign your commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). +6. Send us a pull request, answering any default questions in the pull request + interface. +7. Pay attention to any automated CI failures reported in the pull request, and + stay involved in the conversation. + +GitHub provides additional documentation on [forking a +repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull +request](https://help.github.com/articles/creating-a-pull-request/). + +Before your contribution can be accepted, you will be asked to sign our +[Splunk Contributor License Agreement (CLA)](https://github.com/splunk/cla-agreement/blob/main/CLA.md). + +## Finding contributions to work on + +Looking at the existing issues is a great way to find something to contribute +on. As our repositories, by default, use the default GitHub issue labels +(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at +any 'help wanted' issues is a great place to start. + +## Licensing + +See the [LICENSE](LICENSE) file for our repository's licensing. We will ask you to +confirm the licensing of your contribution. 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 index 249a627..9310ed6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ # SignalFlow Go Client +[![Go Reference](https://pkg.go.dev/badge/github.com/signalfx/signalflow-client-go/signalflow.svg)](https://pkg.go.dev/github.com/signalfx/signalflow-client-go/signalflow) +[![go.mod](https://img.shields.io/github/go-mod/go-version/signalfx/signalflow-client-go)](go.mod) + +[![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md) +[![LICENSE](https://img.shields.io/github/license/signalfx/signalflow-client-go)](LICENSE) + +[![Build Status](https://img.shields.io/github/actions/workflow/status/signalfx/signalflow-client-go/ci.yml?branch=main)](https://github.com/signalfx/signalflow-client-go/actions?query=branch%3Amain) + This is a client for [SignalFlow](https://dev.splunk.com/observability/docs/signalflow) that lets you stream and analyze metric data in real-time for your organization. + +## Contributing + +Read [CONTRIBUTING.md](CONTRIBUTING.md) +before creating an issue or a pull request. + +## License + +SignalFlow Go Client is licensed under the terms of +the Apache Software License version 2.0. +See [the license file](./LICENSE) for more details. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..80d8ea5 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,8 @@ +# Security + +## Reporting Security Issues + +Please *DO NOT* report security vulnerabilities with public GitHub issue +reports. Please [report security issues here]. + +[report security issues here]: https://www.splunk.com/en_us/product-security/report.html diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..9615fdd --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/signalfx/signalflow-client-go + +go 1.21 diff --git a/signalfow/doc.go b/signalfow/doc.go new file mode 100644 index 0000000..844556c --- /dev/null +++ b/signalfow/doc.go @@ -0,0 +1,14 @@ +/* +Package signalflow contains a SignalFx SignalFlow client, +which can be used to execute analytics jobs against the SignalFx backend. + +Not all SignalFlow messages are handled at this time, +and some will be silently dropped. +All of the most important and useful ones are supported though. + +The client will automatically attempt to reconnect to the backend +if the connection is broken after a short delay. + +SignalFlow is documented at https://dev.splunk.com/observability/docs/signalflow/messages. +*/ +package signalflow