From 80f689b9892915845f4f9988d99d40a347cb83e3 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sun, 15 Aug 2021 01:57:35 +0300 Subject: [PATCH 1/9] First public release --- .codebeatsettings | 11 + .github/CODE_OF_CONDUCT.md | 42 ++++ .github/CONTRIBUTING.md | 19 ++ .github/ISSUE_TEMPLATE.md | 53 +++++ .github/PULL_REQUEST_TEMPLATE.md | 24 ++ .github/workflows/ci.yml | 92 ++++++++ .github/workflows/codeql.yml | 28 +++ LICENSE | 201 ++++++++++++++++ Makefile | 50 ++++ README.md | 43 +++- SECURITY.md | 36 +++ api/api.go | 137 +++++++++++ common/updown-badge-server.init | 85 +++++++ common/updown-badge-server.knf | 41 ++++ common/updown-badge-server.logrotate | 9 + common/updown-badge-server.service | 11 + common/updown-badge-server.spec | 143 ++++++++++++ daemon/daemon.go | 327 +++++++++++++++++++++++++++ daemon/server.go | 241 ++++++++++++++++++++ updown-badge-server.go | 20 ++ 20 files changed, 1611 insertions(+), 2 deletions(-) create mode 100644 .codebeatsettings create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/codeql.yml create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 SECURITY.md create mode 100644 api/api.go create mode 100644 common/updown-badge-server.init create mode 100644 common/updown-badge-server.knf create mode 100644 common/updown-badge-server.logrotate create mode 100644 common/updown-badge-server.service create mode 100644 common/updown-badge-server.spec create mode 100644 daemon/daemon.go create mode 100644 daemon/server.go create mode 100644 updown-badge-server.go diff --git a/.codebeatsettings b/.codebeatsettings new file mode 100644 index 0000000..8e5dd08 --- /dev/null +++ b/.codebeatsettings @@ -0,0 +1,11 @@ +{ + "GOLANG": { + "ABC": [15, 25, 50, 70], + "LOC": [30, 45, 70, 100], + "BLOCK_NESTING": [4, 6, 8, 10], + "TOO_MANY_IVARS": [50, 75, 100, 150], + "TOO_MANY_FUNCTIONS": [64, 128, 256, 512], + "TOTAL_LOC": [1500, 3000, 5000, 10000], + "TOTAL_COMPLEXITY": [350, 600, 900, 1200] + } +} diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..45abf3d --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,42 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating +documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free +experience for everyone, regardless of level of experience, gender, gender +identity and expression, sexual orientation, disability, personal appearance, +body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic + addresses, without explicit permission +* Other unethical or unprofessional conduct + +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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +By adopting this Code of Conduct, project maintainers commit themselves to +fairly and consistently applying these principles to every aspect of managing +this project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting a project maintainer at `conduct@essentialkaos.com`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. Maintainers are +obligated to maintain confidentiality with regard to the reporter of an +incident. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d7da3fb --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing Guidelines + +**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.** + +### Issues + +1. Provide product version where the problem was found; +2. Provide info about your environment; +3. Provide detailed info about your problem; +4. Provide steps to reproduce the problem; +5. Provide actual and expected results. + +### Code + +1. Check your code **before** creating pull request; +2. If tests are present in a project, add tests for your code; +3. Add inline documentation for your code; +4. Apply code style used throughout the project; +5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_). diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..a3c74a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,53 @@ +_Before opening an issue, search for similar bug reports or feature requests on GitHub Issues. If yes, please add a_ đź‘Ť _reaction to the existing issue. If no similar issue can be found, fill out either the "Bug Report" or the "Feature Request" section below. Erase the other section and everything on and above this line._ + +### Bug report + +**System info:** + +* **Version used (`updown-badge-server --version`):** +* **OS (e.g. from `/etc/*-release`):** +* **Kernel (`uname -a`):** +* **Install tools:** + +**Steps to reproduce:** + +1. [First Step] +2. [Second Step] +3. [and so on...] + +**Expected behavior:** + +[What you expected to happen] + +**Actual behavior:** + +[What actually happened] + +**Additional info:** + +[Include gist of relevant config, logs, etc.] + +Please run those if possible and link them from a [gist](http://gist.github.com). + +--- + +### Feature Request + +Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them. + +**Proposal:** + +[Description of the feature] + +**Current behavior:** + +[What currently happens] + +**Desired behavior:** + +[What you would like to happen] + +**Use case:** + +[Why is this important (helps with prioritizing requests)] + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e7814b8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +### What did you implement: + +Closes #XXXXX + +### How did you implement it: + +... + +### How can we verify it: + +... + +### TODO's: + +- [ ] Write tests +- [ ] Write documentation +- [ ] Check that there aren't other open pull requests for the same issue/feature +- [ ] Format your source code by `make fmt` +- [ ] Provide verification config / commands +- [ ] Enable "Allow edits from maintainers" for this PR +- [ ] Update the messages below + +**Is this ready for review?:** No +**Is it a breaking change?:** No diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ad522cf --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,92 @@ +name: CI + +on: + push: + branches: [master, develop] + pull_request: + branches: [master] + +jobs: + Go: + name: Go + runs-on: ubuntu-latest + + env: + SRC_DIR: src/github.com/${{ github.repository }} + GO111MODULE: auto + + strategy: + matrix: + go: [ '1.15.x', '1.16.x' ] + + steps: + - name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: ${{ matrix.go }} + id: go + + - name: Setup PATH + run: | + echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV" + echo "GOBIN=${{ github.workspace }}/bin" >> "$GITHUB_ENV" + echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH" + + - name: Checkout + uses: actions/checkout@v2 + with: + path: ${{env.SRC_DIR}} + + - name: Download dependencies + working-directory: ${{env.SRC_DIR}} + run: make deps + + - name: Run tests + working-directory: ${{env.SRC_DIR}} + run: make all + + Aligo: + name: Aligo + runs-on: ubuntu-latest + + needs: Go + + env: + SRC_DIR: src/github.com/${{ github.repository }} + GO111MODULE: auto + + steps: + - name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: '1.16.x' + id: go + + - name: Setup PATH + run: | + echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV" + echo "GOBIN=${{ github.workspace }}/bin" >> "$GITHUB_ENV" + echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH" + + - name: Checkout + uses: actions/checkout@v2 + with: + path: ${{env.SRC_DIR}} + + - name: Download dependencies + working-directory: ${{env.SRC_DIR}} + run: make deps + + - name: Install Aligo + working-directory: ${{env.SRC_DIR}} + run: | + wget https://apps.kaos.st/aligo/latest/linux/x86_64/aligo + chmod +x aligo + + - name: Print Aligo version info + working-directory: ${{env.SRC_DIR}} + run: ./aligo --version + + - name: Check Go structs alignment info + working-directory: ${{env.SRC_DIR}} + run: ./aligo check ./... diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..3444662 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,28 @@ +name: "CodeQL" + +on: + push: + branches: [master, develop] + pull_request: + branches: [master] + schedule: + - cron: '0 17 * * 1,3,5' + +jobs: + analyse: + name: Analyse + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + with: + fetch-depth: 2 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: go + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..12fb719 --- /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 2020 ESSENTIAL KAOS + + 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/Makefile b/Makefile new file mode 100644 index 0000000..c20182f --- /dev/null +++ b/Makefile @@ -0,0 +1,50 @@ +################################################################################ + +# This Makefile generated by GoMakeGen 1.3.2 using next command: +# gomakegen . +# +# More info: https://kaos.sh/gomakegen + +################################################################################ + +.DEFAULT_GOAL := help +.PHONY = fmt vet all clean git-config deps help + +################################################################################ + +all: updown-badge-server ## Build all binaries + +updown-badge-server: ## Build updown-badge-server binary + go build updown-badge-server.go + +install: ## Install all binaries + cp updown-badge-server /usr/bin/updown-badge-server + +uninstall: ## Uninstall all binaries + rm -f /usr/bin/updown-badge-server + +git-config: ## Configure git redirects for stable import path services + git config --global http.https://pkg.re.followRedirects true + +deps: git-config ## Download dependencies + go get -d -v github.com/valyala/fasthttp + go get -d -v pkg.re/essentialkaos/ek.v12 + go get -d -v pkg.re/essentialkaos/go-badge.v1 + +fmt: ## Format source code with gofmt + find . -name "*.go" -exec gofmt -s -w {} \; + +vet: ## Runs go vet over sources + go vet -composites=false -printfuncs=LPrintf,TLPrintf,TPrintf,log.Debug,log.Info,log.Warn,log.Error,log.Critical,log.Print ./... + +clean: ## Remove generated files + rm -f updown-badge-server + +help: ## Show this info + @echo -e '\n\033[1mSupported targets:\033[0m\n' + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \ + | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[33m%-21s\033[0m %s\n", $$1, $$2}' + @echo -e '' + @echo -e '\033[90mGenerated by GoMakeGen 1.3.2\033[0m\n' + +################################################################################ diff --git a/README.md b/README.md index c126323..6352aa4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# updown-badge-server -Service for generating badges for updown.io checks +

+ +

+ GitHub Actions CI Status + GoReportCard + Codebeat badge + GitHub Actions CodeQL Status + +

+ +

Installation • Build Status • Contributing • License

+ +
+ +`updown-badge-server` is a service for generating badges for [updown.io](https://updown.io) checks. + +### Installation + +#### From [ESSENTIAL KAOS Public Repository](https://yum.kaos.st) + +```bash +sudo yum install -y https://yum.kaos.st/get/$(uname -r).rpm +sudo yum install updown-badge-server +``` + +### Build Status + +| Branch | Status | +|--------|----------| +| `master` | [![CI](https://kaos.sh/w/updown-badge-server/ci.svg?branch=master)](https://kaos.sh/w/updown-badge-server/ci?query=branch:master) | +| `develop` | [![CI](https://kaos.sh/w/updown-badge-server/ci.svg?branch=develop)](https://kaos.sh/w/updown-badge-server/ci?query=branch:develop) | + +### Contributing + +Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines). + +### License + +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + +

diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f42c71e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,36 @@ +# Security Policies and Procedures + +This document outlines security procedures and general policies for all +ESSENTIAL KAOS projects. + + * [Reporting a Bug](#reporting-a-bug) + * [Disclosure Policy](#disclosure-policy) + +## Reporting a Bug + +The ESSENTIAL KAOS team and community take all security bugs in our projects +very seriously. Thank you for improving the security of our project. We +appreciate your efforts and responsible disclosure and will make every effort +to acknowledge your contributions. + +Report security bugs by emailing our security team at security@essentialkaos.com. + +The security team will acknowledge your email within 48 hours and will send a +more detailed response within 48 hours, indicating the next steps in handling +your report. After the initial reply to your report, the security team will +endeavor to keep you informed of the progress towards a fix and full +announcement, and may ask for additional information or guidance. + +Report security bugs in third-party dependencies to the person or team +maintaining the dependencies. + +## Disclosure Policy + +When the security team receives a security bug report, they will assign it to a +primary handler. This person will coordinate the fix and release process, +involving the following steps: + + * Confirm the problem and determine the affected versions; + * Audit code to find any similar potential problems; + * Prepare fixes for all releases still under maintenance. These fixes will be + released as fast as possible. diff --git a/api/api.go b/api/api.go new file mode 100644 index 0000000..b929dde --- /dev/null +++ b/api/api.go @@ -0,0 +1,137 @@ +package api + +// ////////////////////////////////////////////////////////////////////////////////// // +// // +// Copyright (c) 2021 ESSENTIAL KAOS // +// Apache License, Version 2.0 // +// // +// ////////////////////////////////////////////////////////////////////////////////// // + +import ( + "encoding/json" + "fmt" + "runtime" + "time" + + "github.com/valyala/fasthttp" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +// API is API URL +const API_URL = "https://updown.io/api/checks" + +// ////////////////////////////////////////////////////////////////////////////////// // + +// Status contains info about check +type Status struct { + Uptime float64 `json:"uptime"` + IsDown bool `json:"down"` +} + +// Apdex contains apdex (Application Performance Index) info +type Apdex struct { + Value float64 `json:"apdex"` +} + +// API is API client struct +type API struct { + client *fasthttp.Client + key string +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +func NewClient(apiKey string) *API { + return &API{ + key: apiKey, + client: &fasthttp.Client{ + MaxIdleConnDuration: 5 * time.Second, + ReadTimeout: 3 * time.Second, + WriteTimeout: 3 * time.Second, + MaxConnsPerHost: 150, + }, + } +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// SetUserAgent set user-agent string based on app name and version +func (api *API) SetUserAgent(app, version string) { + api.client.Name = formatUserAgent(app, version) +} + +// GetStatus fetches status info from updown API +func (api *API) GetStatus(token string) (*Status, error) { + data, err := api.doRequest(API_URL + "/" + token) + + if err != nil { + return nil, err + } + + status := &Status{} + err = json.Unmarshal(data, status) + + if err != nil { + return nil, fmt.Errorf("Can't decode status info: %v", err) + } + + return status, nil +} + +// GetApdex fetches apdex info from updown API +func (api *API) GetApdex(token string) (*Apdex, error) { + data, err := api.doRequest(API_URL + "/" + token + "/metrics") + + if err != nil { + return nil, err + } + + apdex := &Apdex{} + err = json.Unmarshal(data, apdex) + + if err != nil { + return nil, fmt.Errorf("Can't decode apdex info: %v", err) + } + + return apdex, nil +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// doRequest sends request to updown API +func (api *API) doRequest(url string) ([]byte, error) { + req := fasthttp.AcquireRequest() + resp := fasthttp.AcquireResponse() + + defer fasthttp.ReleaseRequest(req) + defer fasthttp.ReleaseResponse(resp) + + req.SetRequestURI(url) + req.URI().SetQueryString("api-key=" + api.key) + + err := api.client.Do(req, resp) + + if err != nil { + return nil, err + } + + statusCode := resp.StatusCode() + + if statusCode != 200 { + return nil, fmt.Errorf("Server return status code %d", statusCode) + } + + return resp.Body(), nil +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// formatUserAgent generate user-agent string for client +func formatUserAgent(app, version string) string { + return fmt.Sprintf( + "%s/%s (go; %s; %s-%s)", + app, version, runtime.Version(), + runtime.GOARCH, runtime.GOOS, + ) +} diff --git a/common/updown-badge-server.init b/common/updown-badge-server.init new file mode 100644 index 0000000..337c952 --- /dev/null +++ b/common/updown-badge-server.init @@ -0,0 +1,85 @@ +#!/bin/bash + +############################################################################### + +# updown-badge-server Startup script for updown-badge-server daemon + +# chkconfig: - 85 15 +# processname: updown-badge-server +# config: /etc/updown-badge-server.knf +# pidfile: /var/run/updown-badge-server/updown-badge-server.pid +# description: Service for generating badges for updown.io checks + +############################################################################### + +source /etc/init.d/kaosv + +############################################################################### + +kv[prog_name]="updown-badge-server" +kv[search_pattern]="updown-badge-server --config" + +binary="/usr/bin/updown-badge-server" +conf_file="/etc/updown-badge-server.knf" + +kv[user]="updown-badge-server" +kv[pid_dir]="/var/run/updown-badge-server" +kv[log]="/var/log/updown-badge-server/errors.log" + +############################################################################### + +kv.addHandler "start" "startServiceHandler" +kv.addHandler "stop" "stopServiceHandler" + +kv.addHandler "start" "preStartServiceHandler" "pre" + +kv.disableOutputRedirect "start" "pre" + +############################################################################### + +preStartServiceHandler() { + local has_errors="" + + [[ ! -x $binary ]] && has_errors=true && kv.error " must be executable file" + [[ ! -r $conf_file ]] && has_errors=true && kv.error " must be readable file" + [[ ! -s $conf_file ]] && has_errors=true && kv.error " can't be empty" + + [[ $has_errors ]] && return $ACTION_ERROR + + return $ACTION_OK +} + +############################################################################### + +startServiceHandler() { + + kv.daemonize "$binary" "--config" "$conf_file" + + [[ $? -ne $ACTION_OK ]] && return $ACTION_ERROR + + sleep 1 + + kv.getStartStatus + + return $? +} + +stopServiceHandler() { + local pid=$(kv.getPid) + + kv.sendSignal "$SIGNAL_TERM" + + if kv.getStopStatus ; then + return $ACTION_OK + else + if [[ -n "$1" ]] ; then + kv.killProcess $pid + fi + + return $ACTION_ERROR + fi +} + +############################################################################### + +kv.go $@ diff --git a/common/updown-badge-server.knf b/common/updown-badge-server.knf new file mode 100644 index 0000000..ef427a2 --- /dev/null +++ b/common/updown-badge-server.knf @@ -0,0 +1,41 @@ +# This is configuration file for updown-badge + +[updown] + + # updown.io read-only API key + api-key: + +[badge] + + # Path to font for badge (we recommend using Verdana) + font: + + # Badge style (plastic, flat, flat-square) + style: flat + +[cache] + + # Status cache period time in seconds (60-3600) + period: 300 + +[server] + + # HTTP server IP + ip: + + # HTTP server port + port: 36100 + +[log] + + # Log file dir + dir: /var/log/updown-badge-server + + # Path to log file + file: {log:dir}/updown-badge-server.log + + # Log permissions + perms: 600 + + # Default log level (debug/info/warn/error/crit) + level: info diff --git a/common/updown-badge-server.logrotate b/common/updown-badge-server.logrotate new file mode 100644 index 0000000..31e7fe9 --- /dev/null +++ b/common/updown-badge-server.logrotate @@ -0,0 +1,9 @@ +/var/log/updown-badge-server/*.log { + weekly + rotate 8 + copytruncate + delaycompress + compress + notifempty + missingok +} diff --git a/common/updown-badge-server.service b/common/updown-badge-server.service new file mode 100644 index 0000000..592c02e --- /dev/null +++ b/common/updown-badge-server.service @@ -0,0 +1,11 @@ +[Unit] +Description=Service for generating badges for updown.io checks +After=network.target + +[Service] +PIDFile=/var/run/updown-badge-server/updown-badge-server.pid +ExecStart=/etc/init.d/updown-badge-server start +ExecStop=/etc/init.d/updown-badge-server stop + +[Install] +WantedBy=multi-user.target diff --git a/common/updown-badge-server.spec b/common/updown-badge-server.spec new file mode 100644 index 0000000..a016cc4 --- /dev/null +++ b/common/updown-badge-server.spec @@ -0,0 +1,143 @@ +################################################################################ + +# rpmbuilder:relative-pack true + +################################################################################ + +%global crc_check pushd ../SOURCES ; sha512sum -c %{SOURCE100} ; popd + +################################################################################ + +%define _posixroot / +%define _root /root +%define _bin /bin +%define _sbin /sbin +%define _srv /srv +%define _home /home +%define _opt /opt +%define _lib32 %{_posixroot}lib +%define _lib64 %{_posixroot}lib64 +%define _libdir32 %{_prefix}%{_lib32} +%define _libdir64 %{_prefix}%{_lib64} +%define _logdir %{_localstatedir}/log +%define _rundir %{_localstatedir}/run +%define _lockdir %{_localstatedir}/lock/subsys +%define _cachedir %{_localstatedir}/cache +%define _spooldir %{_localstatedir}/spool +%define _crondir %{_sysconfdir}/cron.d +%define _loc_prefix %{_prefix}/local +%define _loc_exec_prefix %{_loc_prefix} +%define _loc_bindir %{_loc_exec_prefix}/bin +%define _loc_libdir %{_loc_exec_prefix}/%{_lib} +%define _loc_libdir32 %{_loc_exec_prefix}/%{_lib32} +%define _loc_libdir64 %{_loc_exec_prefix}/%{_lib64} +%define _loc_libexecdir %{_loc_exec_prefix}/libexec +%define _loc_sbindir %{_loc_exec_prefix}/sbin +%define _loc_bindir %{_loc_exec_prefix}/bin +%define _loc_datarootdir %{_loc_prefix}/share +%define _loc_includedir %{_loc_prefix}/include +%define _loc_mandir %{_loc_datarootdir}/man +%define _rpmstatedir %{_sharedstatedir}/rpm-state +%define _pkgconfigdir %{_libdir}/pkgconfig + +################################################################################ + +%define debug_package %{nil} + +################################################################################ + +%define srcdir src/github.com/essentialkaos/%{name} + +################################################################################ + +Summary: Service for generating badges for updown.io checks +Name: updown-badge-server +Version: 1.0.0 +Release: 0%{?dist} +Group: Applications/System +License: Apache License, Version 2.0 +URL: https://github.com/essentialkaos/updown-badge-server + +Source0: https://source.kaos.st/%{name}/%{name}-%{version}.tar.bz2 + +Source100: checksum.sha512 + +BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) + +BuildRequires: golang >= 1.16 + +Requires: kaosv >= 2.16 +Requires: systemd + +Provides: %{name} = %{version}-%{release} + +################################################################################ + +%description +Service for generating badges for updown.io checks. + +################################################################################ + +%prep +%{crc_check} + +%setup -q + +%build +export GOPATH=$(pwd) +export GO111MODULE=auto + +pushd %{srcdir} + %{__make} %{?_smp_mflags} all +popd + +%install +rm -rf %{buildroot} + +install -dm 755 %{buildroot}%{_bindir} +install -dm 755 %{buildroot}%{_sysconfdir} +install -dm 755 %{buildroot}%{_sysconfdir}/logrotate.d +install -dm 755 %{buildroot}%{_initddir} +install -dm 755 %{buildroot}%{_unitdir} +install -dm 755 %{buildroot}%{_logdir}/%{name} + +install -pm 755 %{srcdir}/%{name} \ + %{buildroot}%{_bindir}/ + +install -pm 644 %{srcdir}/common/%{name}.knf \ + %{buildroot}%{_sysconfdir}/ + +install -pm 755 %{srcdir}/common/%{name}.init \ + %{buildroot}%{_initddir}/%{name} + +install -pm 644 %{srcdir}/common/%{name}.logrotate \ + %{buildroot}%{_sysconfdir}/logrotate.d/%{name} + +install -pDm 644 %{srcdir}/common/%{name}.service \ + %{buildroot}%{_unitdir}/ + +%clean +rm -rf %{buildroot} + +%pre +getent group %{name} >/dev/null || groupadd -r %{name} +getent passwd %{name} >/dev/null || useradd -r -M -g %{name} -s /sbin/nologin %{name} +exit 0 + +################################################################################ + +%files +%defattr(-,root,root,-) +%doc LICENSE +%attr(-,%{name},%{name}) %dir %{_logdir}/%{name} +%config(noreplace) %{_sysconfdir}/%{name}.knf +%config(noreplace) %{_sysconfdir}/logrotate.d/%{name} +%{_unitdir}/%{name}.service +%{_initddir}/%{name} +%{_bindir}/%{name} + +################################################################################ + +%changelog +* Sat Aug 14 2021 Anton Novojilov - 1.0.0-0 +- Initial build for kaos-repo diff --git a/daemon/daemon.go b/daemon/daemon.go new file mode 100644 index 0000000..222c34c --- /dev/null +++ b/daemon/daemon.go @@ -0,0 +1,327 @@ +package daemon + +// ////////////////////////////////////////////////////////////////////////////////// // +// // +// Copyright (c) 2021 ESSENTIAL KAOS // +// Apache License, Version 2.0 // +// // +// ////////////////////////////////////////////////////////////////////////////////// // + +import ( + "os" + "strings" + "time" + + "pkg.re/essentialkaos/ek.v12/cache" + "pkg.re/essentialkaos/ek.v12/fmtc" + "pkg.re/essentialkaos/ek.v12/knf" + "pkg.re/essentialkaos/ek.v12/log" + "pkg.re/essentialkaos/ek.v12/options" + "pkg.re/essentialkaos/ek.v12/pid" + "pkg.re/essentialkaos/ek.v12/signal" + "pkg.re/essentialkaos/ek.v12/usage" + + knfv "pkg.re/essentialkaos/ek.v12/knf/validators" + knff "pkg.re/essentialkaos/ek.v12/knf/validators/fs" + knfn "pkg.re/essentialkaos/ek.v12/knf/validators/network" + knfr "pkg.re/essentialkaos/ek.v12/knf/validators/regexp" + + "pkg.re/essentialkaos/go-badge.v1" + + "github.com/valyala/fasthttp" + + "github.com/essentialkaos/updown-badge-server/api" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +// Basic service info +const ( + APP = "UpDownBadgeServer" + VER = "1.0.0" + DESC = "Service for generating badges for updown.io checks" +) + +const ( + MIN_PORT = 1025 + MAX_PORT = 65535 + MIN_CACHE_PERIOD = 60 // 1 min + MAX_CACHE_PERIOD = 3600 // 1 hour +) + +// Options +const ( + OPT_CONFIG = "c:config" + OPT_NO_COLOR = "nc:no-color" + OPT_HELP = "h:help" + OPT_VERSION = "v:version" +) + +// Configuration file properties +const ( + UPDOWN_API_KEY = "updown:api-key" + BADGE_FONT = "badge:font" + BADGE_STYLE = "badge:style" + CACHE_PERIOD = "cache:period" + SERVER_IP = "server:ip" + SERVER_PORT = "server:port" + LOG_DIR = "log:dir" + LOG_FILE = "log:file" + LOG_PERMS = "log:perms" + LOG_LEVEL = "log:level" +) + +// Pid file info +const ( + PID_DIR = "/var/run/updown-badge-server" + PID_FILE = "updown-badge-server.pid" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +// optMap contains information about all supported options +var optMap = options.Map{ + OPT_CONFIG: {Value: "/etc/updown-badge-server.knf"}, + OPT_NO_COLOR: {Type: options.BOOL}, + OPT_HELP: {Type: options.BOOL, Alias: "u:usage"}, + OPT_VERSION: {Type: options.BOOL, Alias: "ver"}, +} + +var udAPI *api.API +var server *fasthttp.Server +var badgeCache *cache.Cache +var badgeGen *badge.Generator +var badgeStyle string + +// ////////////////////////////////////////////////////////////////////////////////// // + +func Init() { + _, errs := options.Parse(optMap) + + if len(errs) != 0 { + for _, err := range errs { + printError(err.Error()) + } + + os.Exit(1) + } + + configureUI() + + if options.GetB(OPT_VERSION) { + os.Exit(showAbout()) + } + + if options.GetB(OPT_HELP) { + os.Exit(showUsage()) + } + + loadConfig() + validateConfig() + registerSignalHandlers() + setupLogger() + createPidFile() + + log.Aux(strings.Repeat("-", 80)) + log.Aux("%s %s starting…", APP, VER) + + start() +} + +// configureUI configures user interface +func configureUI() { + if options.GetB(OPT_NO_COLOR) { + fmtc.DisableColors = true + } +} + +// loadConfig reads and parses configuration file +func loadConfig() { + err := knf.Global(options.GetS(OPT_CONFIG)) + + if err != nil { + printErrorAndExit(err.Error()) + } +} + +// validateConfig validates configuration file values +func validateConfig() { + errs := knf.Validate([]*knf.Validator{ + {UPDOWN_API_KEY, knfv.Empty, nil}, + {SERVER_PORT, knfv.Empty, nil}, + + {BADGE_FONT, knff.Perms, "FRS"}, + {BADGE_STYLE, knfv.NotContains, []string{ + STYLE_PLASTIC, STYLE_FLAT, STYLE_FLAT_SQUARE, + }}, + + {UPDOWN_API_KEY, knfv.NotLen, 23}, + {UPDOWN_API_KEY, knfr.Regexp, "^ro-[0-9A-Za-z]{20}$"}, + + {CACHE_PERIOD, knfv.Less, MIN_CACHE_PERIOD}, + {CACHE_PERIOD, knfv.Greater, MAX_CACHE_PERIOD}, + + {SERVER_PORT, knfv.Less, MIN_PORT}, + {SERVER_PORT, knfv.Greater, MAX_PORT}, + + {SERVER_IP, knfn.IP, nil}, + + {LOG_DIR, knff.Perms, "DW"}, + {LOG_DIR, knff.Perms, "DX"}, + + {LOG_LEVEL, knfv.NotContains, []string{ + "debug", "info", "warn", "error", "crit", + }}, + }) + + if len(errs) != 0 { + printError("Error while configuration file validation:") + + for _, err := range errs { + printError(" %v", err) + } + + os.Exit(1) + } +} + +// registerSignalHandlers registers signal handlers +func registerSignalHandlers() { + signal.Handlers{ + signal.TERM: termSignalHandler, + signal.INT: intSignalHandler, + signal.HUP: hupSignalHandler, + }.TrackAsync() +} + +// setupLogger confugures logger subsystems +func setupLogger() { + err := log.Set(knf.GetS(LOG_FILE), knf.GetM(LOG_PERMS, 644)) + + if err != nil { + printErrorAndExit(err.Error()) + } + + err = log.MinLevel(knf.GetS(LOG_LEVEL)) + + if err != nil { + printErrorAndExit(err.Error()) + } +} + +// createPidFile creates PID file +func createPidFile() { + pid.Dir = PID_DIR + + err := pid.Create(PID_FILE) + + if err != nil { + printErrorAndExit(err.Error()) + } +} + +// start configures and starts all subsystems +func start() { + var err error + + badgeStyle = knf.GetS(BADGE_STYLE, "flat") + badgeGen, err = badge.NewGenerator(knf.GetS(BADGE_FONT), 11) + + if err != nil { + log.Crit("Can't load font for badges: %v", err) + shutdown(1) + } + + udAPI = api.NewClient(knf.GetS(UPDOWN_API_KEY)) + udAPI.SetUserAgent(APP, VER) + + badgeCache = cache.New(knf.GetD(CACHE_PERIOD), time.Minute) + + err = startHTTPServer(knf.GetS(SERVER_IP), knf.GetS(SERVER_PORT)) + + if err != nil { + log.Crit("Can't start HTTP server: %v", err) + shutdown(1) + } +} + +// intSignalHandler is INT signal handler +func intSignalHandler() { + log.Aux("Received INT signal, shutdown…") + shutdown(0) +} + +// termSignalHandler is TERM signal handler +func termSignalHandler() { + log.Aux("Received TERM signal, shutdown…") + shutdown(0) +} + +// hupSignalHandler is HUP signal handler +func hupSignalHandler() { + log.Info("Received HUP signal, log will be reopened…") + log.Reopen() + log.Info("Log reopened by HUP signal") +} + +// printError prints error message to console +func printError(f string, a ...interface{}) { + fmtc.Fprintf(os.Stderr, "{r}"+f+"{!}\n", a...) +} + +// printError prints warning message to console +func printWarn(f string, a ...interface{}) { + fmtc.Fprintf(os.Stderr, "{y}"+f+"{!}\n", a...) +} + +// printErrorAndExit print error mesage and exit with exit code 1 +func printErrorAndExit(f string, a ...interface{}) { + printError(f, a...) + os.Exit(1) +} + +// shutdown stops deamon +func shutdown(code int) { + if server != nil { + err := server.Shutdown() + + if err != nil { + log.Error("Can't gracefully shut down HTTP server: %v", err) + } + } + + pid.Remove(PID_FILE) + os.Exit(code) +} + +// ////////////////////////////////////////////////////////////////////////////////// // + +// showUsage prints usage info +func showUsage() int { + info := usage.NewInfo() + + info.AddOption(OPT_CONFIG, "Path to configuration file", "file") + info.AddOption(OPT_NO_COLOR, "Disable colors in output") + info.AddOption(OPT_HELP, "Show this help message") + info.AddOption(OPT_VERSION, "Show version") + + info.Render() + + return 0 +} + +// showAbout prints info about version +func showAbout() int { + usage := &usage.About{ + App: APP, + Version: VER, + Desc: DESC, + Year: 2009, + Owner: "ESSENTIAL KAOS", + License: "Apache License, Version 2.0 ", + } + + usage.Render() + + return 0 +} diff --git a/daemon/server.go b/daemon/server.go new file mode 100644 index 0000000..ece34a0 --- /dev/null +++ b/daemon/server.go @@ -0,0 +1,241 @@ +package daemon + +// ////////////////////////////////////////////////////////////////////////////////// // +// // +// Copyright (c) 2021 ESSENTIAL KAOS // +// Apache License, Version 2.0 // +// // +// ////////////////////////////////////////////////////////////////////////////////// // + +import ( + "fmt" + "strings" + + "pkg.re/essentialkaos/ek.v12/log" + "pkg.re/essentialkaos/ek.v12/strutil" + + "pkg.re/essentialkaos/go-badge.v1" + + "github.com/valyala/fasthttp" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +const ( + CHECK_UNKNOWN uint8 = 0 + CHECK_STATUS = 1 + CHECK_UPTIME = 2 + CHECK_APDEX = 3 +) + +const ( + STYLE_PLASTIC = "plastic" + STYLE_FLAT = "flat" + STYLE_FLAT_SQUARE = "flat-square" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +// startHTTPServer start HTTP server +func startHTTPServer(ip, port string) error { + addr := ip + ":" + port + + log.Info("HTTP server is started on %s", addr) + + server = &fasthttp.Server{ + Handler: fastHTTPHandler, + Name: APP + "/" + VER, + } + + return server.ListenAndServe(addr) +} + +// fastHTTPHandler is a handler for http requests +func fastHTTPHandler(ctx *fasthttp.RequestCtx) { + defer requestRecover(ctx) + + path := string(ctx.Path()) + + log.Debug("Got request '%s'", path) + + if !isValidRequestPath(path) { + ctx.SetStatusCode(404) + return + } + + badgeHandler(ctx, path) +} + +// requestRecover recovers panic in request +func requestRecover(ctx *fasthttp.RequestCtx) { + r := recover() + + if r != nil { + log.Error("Recovered internal error in HTTP request handler: %v", r) + ctx.SetStatusCode(501) + } +} + +// badgeHandler handler badge request +func badgeHandler(ctx *fasthttp.RequestCtx, path string) { + token, checkType := parsePath(path) + + log.Debug("Generating badge for token %s (checkType: %d)", token, checkType) + + ctx.Response.Header.Set("Content-Type", "image/svg+xml") + ctx.Response.Header.Set("Cache-Control", "no-cache, no-store, must-revalidate") + ctx.Response.Header.Set("Pragma", "no-cache") + ctx.Response.Header.Set("Expires", "0") + + ctx.Write(getBadge(token, checkType)) + ctx.SetStatusCode(200) +} + +// getBadge returns badge for check with given token and check type +func getBadge(token string, checkType uint8) []byte { + if checkType == CHECK_UNKNOWN { + token = "UNKNOWN" + } + + cacheKey := fmt.Sprintf("%s:%d", token, checkType) + + if badgeCache.Has(cacheKey) { + return badgeCache.Get(cacheKey).([]byte) + } + + var badgeData []byte + + switch checkType { + case CHECK_STATUS: + badgeData = genStatusBadge(token) + case CHECK_UPTIME: + badgeData = genUptimeBadge(token) + case CHECK_APDEX: + badgeData = genApdexBadge(token) + default: + badgeData = genBadge("status", "unknown", badge.COLOR_INACTIVE) + } + + badgeCache.Set(cacheKey, badgeData) + + return badgeData +} + +// genStatusBadge generates status badge +func genStatusBadge(token string) []byte { + label := "status" + status, err := udAPI.GetStatus(token) + + if err != nil { + log.Error("Can't get status info: %v", err) + } + + switch { + case err != nil || status == nil: + return genBadge(label, "unknown", badge.COLOR_INACTIVE) + case status.IsDown: + return genBadge(label, "down", badge.COLOR_CRITICAL) + } + + return genBadge(label, "up", badge.COLOR_SUCCESS) +} + +// genUptimeBadge generates uptime badge +func genUptimeBadge(token string) []byte { + var value string + + label := "uptime" + status, err := udAPI.GetStatus(token) + + if err != nil { + log.Error("Can't get status info: %v", err) + } else { + value = fmt.Sprintf("%.2f%%", status.Uptime) + } + + switch { + case err != nil || status == nil: + return genBadge(label, "unknown", badge.COLOR_INACTIVE) + case status.Uptime < 90: + return genBadge(label, value, badge.COLOR_RED) + case status.Uptime < 95: + return genBadge(label, value, badge.COLOR_ORANGE) + case status.Uptime < 100: + return genBadge(label, value, badge.COLOR_YELLOW) + } + + return genBadge(label, "100%", badge.COLOR_GREEN) +} + +// genApdexBadge generates apdex badge +func genApdexBadge(token string) []byte { + var value string + + label := "apdex" + apdex, err := udAPI.GetApdex(token) + + if err != nil { + log.Error("Can't get apdex info: %v", err) + } else { + value = fmt.Sprintf("%.2f", apdex.Value) + } + + switch { + case err != nil || apdex == nil: + return genBadge(label, "unknown", badge.COLOR_INACTIVE) + case apdex.Value < 0.8: + return genBadge(label, value, badge.COLOR_RED) + case apdex.Value < 0.9: + return genBadge(label, value, badge.COLOR_ORANGE) + case apdex.Value < 0.995: + return genBadge(label, value, badge.COLOR_YELLOW) + } + + return genBadge(label, "1.0", badge.COLOR_GREEN) +} + +// genBadge generates badge with global style +func genBadge(label, value, color string) []byte { + switch badgeStyle { + case STYLE_PLASTIC: + return badgeGen.GeneratePlastic(label, value, color) + + case STYLE_FLAT: + return badgeGen.GenerateFlat(label, value, color) + + case STYLE_FLAT_SQUARE: + return badgeGen.GenerateFlatSquare(label, value, color) + } + + return nil +} + +// isValidRequestPath checks if request path is ok +func isValidRequestPath(path string) bool { + if strings.Count(path, "/") != 2 { + return false + } + + if !strings.HasSuffix(path, ".svg") { + return false + } + + return true +} + +// parsePath parses request path +func parsePath(path string) (string, uint8) { + token := strutil.ReadField(path, 0, false, "/") + badge := strutil.ReadField(path, 1, false, "/") + + switch badge { + case "status.svg": + return token, CHECK_STATUS + case "uptime.svg": + return token, CHECK_UPTIME + case "apdex.svg": + return token, CHECK_APDEX + } + + return "", 0 +} diff --git a/updown-badge-server.go b/updown-badge-server.go new file mode 100644 index 0000000..6cc4612 --- /dev/null +++ b/updown-badge-server.go @@ -0,0 +1,20 @@ +package main + +// ////////////////////////////////////////////////////////////////////////////////// // +// // +// Copyright (c) 2021 ESSENTIAL KAOS // +// Apache License, Version 2.0 // +// // +// ////////////////////////////////////////////////////////////////////////////////// // + +import ( + DAEMON "github.com/essentialkaos/updown-badge-server/daemon" +) + +// ////////////////////////////////////////////////////////////////////////////////// // + +func main() { + DAEMON.Init() +} + +// ////////////////////////////////////////////////////////////////////////////////// // From f4f365e7dc990b03a1675e7043ab1d6336ddb1d5 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:02:52 +0300 Subject: [PATCH 2/9] Add number of CPUs configuration --- common/updown-badge-server.knf | 7 ++++++- common/updown-badge-server.spec | 5 ++++- daemon/daemon.go | 23 ++++++++++++++++++++++- 3 files changed, 32 insertions(+), 3 deletions(-) diff --git a/common/updown-badge-server.knf b/common/updown-badge-server.knf index ef427a2..25d6a07 100644 --- a/common/updown-badge-server.knf +++ b/common/updown-badge-server.knf @@ -1,4 +1,9 @@ -# This is configuration file for updown-badge +# Configuration file for updown-badge-server + +[main] + + # Maximum number of CPUs that can be executing simultaneously + max-procs: 4 [updown] diff --git a/common/updown-badge-server.spec b/common/updown-badge-server.spec index a016cc4..bf5e9b0 100644 --- a/common/updown-badge-server.spec +++ b/common/updown-badge-server.spec @@ -52,7 +52,7 @@ Summary: Service for generating badges for updown.io checks Name: updown-badge-server -Version: 1.0.0 +Version: 1.1.0 Release: 0%{?dist} Group: Applications/System License: Apache License, Version 2.0 @@ -139,5 +139,8 @@ exit 0 ################################################################################ %changelog +* Wed Aug 18 2021 Anton Novojilov - 1.1.0-0 +- Added number of CPUs configuration + * Sat Aug 14 2021 Anton Novojilov - 1.0.0-0 - Initial build for kaos-repo diff --git a/daemon/daemon.go b/daemon/daemon.go index 222c34c..57e5edc 100644 --- a/daemon/daemon.go +++ b/daemon/daemon.go @@ -9,6 +9,7 @@ package daemon import ( "os" + "runtime" "strings" "time" @@ -38,7 +39,7 @@ import ( // Basic service info const ( APP = "UpDownBadgeServer" - VER = "1.0.0" + VER = "1.1.0" DESC = "Service for generating badges for updown.io checks" ) @@ -47,6 +48,8 @@ const ( MAX_PORT = 65535 MIN_CACHE_PERIOD = 60 // 1 min MAX_CACHE_PERIOD = 3600 // 1 hour + MIN_PROCS = 1 + MAX_PROCS = 256 ) // Options @@ -59,6 +62,7 @@ const ( // Configuration file properties const ( + MAIN_MAX_PROCS = "main:max-procs" UPDOWN_API_KEY = "updown:api-key" BADGE_FONT = "badge:font" BADGE_STYLE = "badge:style" @@ -118,6 +122,7 @@ func Init() { loadConfig() validateConfig() + configureRuntime() registerSignalHandlers() setupLogger() createPidFile() @@ -150,6 +155,10 @@ func validateConfig() { {UPDOWN_API_KEY, knfv.Empty, nil}, {SERVER_PORT, knfv.Empty, nil}, + {MAIN_MAX_PROCS, knfv.TypeNum, nil}, + {CACHE_PERIOD, knfv.TypeNum, nil}, + {SERVER_PORT, knfv.TypeNum, nil}, + {BADGE_FONT, knff.Perms, "FRS"}, {BADGE_STYLE, knfv.NotContains, []string{ STYLE_PLASTIC, STYLE_FLAT, STYLE_FLAT_SQUARE, @@ -158,6 +167,9 @@ func validateConfig() { {UPDOWN_API_KEY, knfv.NotLen, 23}, {UPDOWN_API_KEY, knfr.Regexp, "^ro-[0-9A-Za-z]{20}$"}, + {MAIN_MAX_PROCS, knfv.Less, MIN_PROCS}, + {MAIN_MAX_PROCS, knfv.Greater, MAX_PROCS}, + {CACHE_PERIOD, knfv.Less, MIN_CACHE_PERIOD}, {CACHE_PERIOD, knfv.Greater, MAX_CACHE_PERIOD}, @@ -185,6 +197,15 @@ func validateConfig() { } } +// configureRuntime configures runtime +func configureRuntime() { + if !knf.HasProp(MAIN_MAX_PROCS) { + return + } + + runtime.GOMAXPROCS(knf.GetI(MAIN_MAX_PROCS)) +} + // registerSignalHandlers registers signal handlers func registerSignalHandlers() { signal.Handlers{ From 35bcf7b94d8bea79a7eccc79d6adee2d6119e7f2 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:03:23 +0300 Subject: [PATCH 3/9] Add Go 1.17 to testing targets --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ad522cf..f67b7c5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,7 +17,7 @@ jobs: strategy: matrix: - go: [ '1.15.x', '1.16.x' ] + go: [ '1.16.x', '1.17.x' ] steps: - name: Set up Go From cb20f728e6465cce0a64433ebcc669b271fb8a50 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:04:45 +0300 Subject: [PATCH 4/9] Set version to 1.0.0 --- common/updown-badge-server.spec | 5 +---- daemon/daemon.go | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/common/updown-badge-server.spec b/common/updown-badge-server.spec index bf5e9b0..a016cc4 100644 --- a/common/updown-badge-server.spec +++ b/common/updown-badge-server.spec @@ -52,7 +52,7 @@ Summary: Service for generating badges for updown.io checks Name: updown-badge-server -Version: 1.1.0 +Version: 1.0.0 Release: 0%{?dist} Group: Applications/System License: Apache License, Version 2.0 @@ -139,8 +139,5 @@ exit 0 ################################################################################ %changelog -* Wed Aug 18 2021 Anton Novojilov - 1.1.0-0 -- Added number of CPUs configuration - * Sat Aug 14 2021 Anton Novojilov - 1.0.0-0 - Initial build for kaos-repo diff --git a/daemon/daemon.go b/daemon/daemon.go index 57e5edc..9723603 100644 --- a/daemon/daemon.go +++ b/daemon/daemon.go @@ -39,7 +39,7 @@ import ( // Basic service info const ( APP = "UpDownBadgeServer" - VER = "1.1.0" + VER = "1.0.0" DESC = "Service for generating badges for updown.io checks" ) From 188fffb47f164da1e0c89831d480715475aa73f5 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:31:59 +0300 Subject: [PATCH 5/9] Add redirect for non-badge URLs --- common/updown-badge-server.knf | 3 +++ daemon/daemon.go | 27 ++++++++++++++++----------- daemon/server.go | 7 ++++++- 3 files changed, 25 insertions(+), 12 deletions(-) diff --git a/common/updown-badge-server.knf b/common/updown-badge-server.knf index 25d6a07..9b78c70 100644 --- a/common/updown-badge-server.knf +++ b/common/updown-badge-server.knf @@ -31,6 +31,9 @@ # HTTP server port port: 36100 + # URL for redirect request to / + redirect: https://kaos.sh/updown-badge-server + [log] # Log file dir diff --git a/daemon/daemon.go b/daemon/daemon.go index 9723603..2801fed 100644 --- a/daemon/daemon.go +++ b/daemon/daemon.go @@ -62,17 +62,18 @@ const ( // Configuration file properties const ( - MAIN_MAX_PROCS = "main:max-procs" - UPDOWN_API_KEY = "updown:api-key" - BADGE_FONT = "badge:font" - BADGE_STYLE = "badge:style" - CACHE_PERIOD = "cache:period" - SERVER_IP = "server:ip" - SERVER_PORT = "server:port" - LOG_DIR = "log:dir" - LOG_FILE = "log:file" - LOG_PERMS = "log:perms" - LOG_LEVEL = "log:level" + MAIN_MAX_PROCS = "main:max-procs" + UPDOWN_API_KEY = "updown:api-key" + BADGE_FONT = "badge:font" + BADGE_STYLE = "badge:style" + CACHE_PERIOD = "cache:period" + SERVER_IP = "server:ip" + SERVER_PORT = "server:port" + SERVER_REDIRECT = "server:redirect" + LOG_DIR = "log:dir" + LOG_FILE = "log:file" + LOG_PERMS = "log:perms" + LOG_LEVEL = "log:level" ) // Pid file info @@ -96,6 +97,7 @@ var server *fasthttp.Server var badgeCache *cache.Cache var badgeGen *badge.Generator var badgeStyle string +var redirectURL string // ////////////////////////////////////////////////////////////////////////////////// // @@ -177,6 +179,7 @@ func validateConfig() { {SERVER_PORT, knfv.Greater, MAX_PORT}, {SERVER_IP, knfn.IP, nil}, + {SERVER_REDIRECT, knfn.URL, nil}, {LOG_DIR, knff.Perms, "DW"}, {LOG_DIR, knff.Perms, "DX"}, @@ -246,6 +249,8 @@ func start() { var err error badgeStyle = knf.GetS(BADGE_STYLE, "flat") + redirectURL = knf.GetS(SERVER_REDIRECT) + badgeGen, err = badge.NewGenerator(knf.GetS(BADGE_FONT), 11) if err != nil { diff --git a/daemon/server.go b/daemon/server.go index ece34a0..bd829f7 100644 --- a/daemon/server.go +++ b/daemon/server.go @@ -59,7 +59,12 @@ func fastHTTPHandler(ctx *fasthttp.RequestCtx) { log.Debug("Got request '%s'", path) if !isValidRequestPath(path) { - ctx.SetStatusCode(404) + if redirectURL == "" { + ctx.SetStatusCode(404) + } else { + ctx.Redirect(redirectURL, 301) + } + return } From b87af99dfb17d612c7a3019c5676e8a70e30a509 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:45:51 +0300 Subject: [PATCH 6/9] Improve README --- .github/images/apdex_085.svg | 1 + .github/images/apdex_094.svg | 1 + .github/images/apdex_098.svg | 1 + .github/images/apdex_1.svg | 1 + .github/images/status_down.svg | 1 + .github/images/status_up.svg | 1 + .github/images/uptime_100.svg | 1 + .github/images/uptime_88.svg | 1 + .github/images/uptime_94.svg | 1 + .github/images/uptime_99.svg | 1 + README.md | 8 ++++++++ 11 files changed, 18 insertions(+) create mode 100644 .github/images/apdex_085.svg create mode 100644 .github/images/apdex_094.svg create mode 100644 .github/images/apdex_098.svg create mode 100644 .github/images/apdex_1.svg create mode 100644 .github/images/status_down.svg create mode 100644 .github/images/status_up.svg create mode 100644 .github/images/uptime_100.svg create mode 100644 .github/images/uptime_88.svg create mode 100644 .github/images/uptime_94.svg create mode 100644 .github/images/uptime_99.svg diff --git a/.github/images/apdex_085.svg b/.github/images/apdex_085.svg new file mode 100644 index 0000000..1a873d2 --- /dev/null +++ b/.github/images/apdex_085.svg @@ -0,0 +1 @@ +apdex: 0.85apdex0.85 \ No newline at end of file diff --git a/.github/images/apdex_094.svg b/.github/images/apdex_094.svg new file mode 100644 index 0000000..6a35e2f --- /dev/null +++ b/.github/images/apdex_094.svg @@ -0,0 +1 @@ +apdex: 0.94apdex0.94 \ No newline at end of file diff --git a/.github/images/apdex_098.svg b/.github/images/apdex_098.svg new file mode 100644 index 0000000..84872d7 --- /dev/null +++ b/.github/images/apdex_098.svg @@ -0,0 +1 @@ +apdex: 0.98apdex0.98 \ No newline at end of file diff --git a/.github/images/apdex_1.svg b/.github/images/apdex_1.svg new file mode 100644 index 0000000..313d8a0 --- /dev/null +++ b/.github/images/apdex_1.svg @@ -0,0 +1 @@ +apdex: 1.0apdex1.0 \ No newline at end of file diff --git a/.github/images/status_down.svg b/.github/images/status_down.svg new file mode 100644 index 0000000..94c37a4 --- /dev/null +++ b/.github/images/status_down.svg @@ -0,0 +1 @@ +status: downstatusdown \ No newline at end of file diff --git a/.github/images/status_up.svg b/.github/images/status_up.svg new file mode 100644 index 0000000..b3c4b11 --- /dev/null +++ b/.github/images/status_up.svg @@ -0,0 +1 @@ +status: upstatusup \ No newline at end of file diff --git a/.github/images/uptime_100.svg b/.github/images/uptime_100.svg new file mode 100644 index 0000000..25cdb6f --- /dev/null +++ b/.github/images/uptime_100.svg @@ -0,0 +1 @@ +uptime: 100%uptime100% \ No newline at end of file diff --git a/.github/images/uptime_88.svg b/.github/images/uptime_88.svg new file mode 100644 index 0000000..8f82b79 --- /dev/null +++ b/.github/images/uptime_88.svg @@ -0,0 +1 @@ +uptime: 88.64%uptime88.64% \ No newline at end of file diff --git a/.github/images/uptime_94.svg b/.github/images/uptime_94.svg new file mode 100644 index 0000000..309eac2 --- /dev/null +++ b/.github/images/uptime_94.svg @@ -0,0 +1 @@ +uptime: 94.23%uptime94.23% \ No newline at end of file diff --git a/.github/images/uptime_99.svg b/.github/images/uptime_99.svg new file mode 100644 index 0000000..3cacb14 --- /dev/null +++ b/.github/images/uptime_99.svg @@ -0,0 +1 @@ +uptime: 98.45%uptime98.45% \ No newline at end of file diff --git a/README.md b/README.md index 6352aa4..2217061 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,14 @@ sudo yum install -y https://yum.kaos.st/get/$(uname -r).rpm sudo yum install updown-badge-server ``` +### Badges examples + +| Endpoint | Badges | +|-----------------------|--------| +| `/{token}/status.svg` | ![status-up](.github/images/status_up.svg) ![status-down](.github/images/status_down.svg) | +| `/{token}/uptime.svg` || +| `/{token}/apdex.svg` || + ### Build Status | Branch | Status | From 5e6b71dfe029f116f303a16beb90e90bf1aed0c4 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:47:14 +0300 Subject: [PATCH 7/9] Improve README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2217061..f4eaeda 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ sudo yum install updown-badge-server | Endpoint | Badges | |-----------------------|--------| | `/{token}/status.svg` | ![status-up](.github/images/status_up.svg) ![status-down](.github/images/status_down.svg) | -| `/{token}/uptime.svg` || +| `/{token}/uptime.svg` | ![uptime-1](.github/images/uptime_100.svg) ![uptime-2](.github/images/uptime_99.svg) ![uptime-3](.github/images/uptime_94.svg) ![uptime-4](.github/images/uptime_88.svg)| | `/{token}/apdex.svg` || ### Build Status From 530192818d0b8d7622cf06673de97ef0c78b9c69 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:48:22 +0300 Subject: [PATCH 8/9] Improve README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4eaeda..16e6b3b 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ sudo yum install updown-badge-server | Endpoint | Badges | |-----------------------|--------| | `/{token}/status.svg` | ![status-up](.github/images/status_up.svg) ![status-down](.github/images/status_down.svg) | -| `/{token}/uptime.svg` | ![uptime-1](.github/images/uptime_100.svg) ![uptime-2](.github/images/uptime_99.svg) ![uptime-3](.github/images/uptime_94.svg) ![uptime-4](.github/images/uptime_88.svg)| -| `/{token}/apdex.svg` || +| `/{token}/uptime.svg` | ![uptime-1](.github/images/uptime_100.svg) ![uptime-2](.github/images/uptime_99.svg) ![uptime-3](.github/images/uptime_94.svg) ![uptime-4](.github/images/uptime_88.svg) | +| `/{token}/apdex.svg` | ![apdex-1](.github/images/apdex_1.svg) ![apdex-1](.github/images/apdex_098.svg) ![apdex-1](.github/images/apdex_094.svg) ![apdex-1](.github/images/apdex_085.svg) | ### Build Status From 046e24c1c9aaee8a7959ea37bed528463466db06 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Wed, 18 Aug 2021 00:49:14 +0300 Subject: [PATCH 9/9] Improve README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16e6b3b..90a7178 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

-

Installation • Build Status • Contributing • License

+

Installation • Badges • Build Status • Contributing • License


@@ -23,7 +23,7 @@ sudo yum install -y https://yum.kaos.st/get/$(uname -r).rpm sudo yum install updown-badge-server ``` -### Badges examples +### Badges | Endpoint | Badges | |-----------------------|--------|