Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Tvion committed Dec 30, 2024
1 parent 0511aad commit b97707b
Show file tree
Hide file tree
Showing 42 changed files with 5,862 additions and 0 deletions.
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/
75 changes: 75 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
name: Build Artifacts
on:
release:
types: [created]
push:
branches:
- '**'
workflow_dispatch:
inputs:
publish_docker:
description: "Publish image to ghcr.io/netcracker/pgskipper-operator"
type: boolean
default: false
required: false

env:
TAG_NAME: ${{ github.event.release.tag_name || github.ref }}
GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}
PUSH: ${{ github.event_name != 'workflow_dispatch' || inputs.publish_docker }}

jobs:
multiplatform_build:
strategy:
fail-fast: false
matrix:
component:
- name: pgskipper-monitoring-agent
file: Dockerfile
context: ""
runs-on: ubuntu-latest
steps:
- name: Validate
run: |
if [[ "${{ github.event_name }}" == "workflow_dispatch" && "${{ github.ref }}" == refs/tags* ]]; then
echo -e "\033[91mManual workflow run on tags is not allowed!\033[0m"
exit 1
fi
- name: Checkout
uses: actions/checkout@v4
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${GITHUB_ACTOR}
password: ${{secrets.GITHUB_TOKEN}}
- name: Prepare Tag
run: echo "TAG_NAME=$(echo ${TAG_NAME} | sed 's@refs/tags/@@;s@refs/heads/@@;s@/@_@g')" >> $GITHUB_ENV
- name: Get package IDs for delete
id: get-ids-for-delete
uses: Netcracker/[email protected]
with:
component-name: ${{ matrix.component.name }}
component-tag: ${{ env.TAG_NAME }}
access-token: ${{ secrets.GH_ACCESS_TOKEN }}
if: ${{ env.PUSH }}
- name: Build and push
uses: docker/build-push-action@v6
with:
no-cache: true
context: ${{ matrix.component.context }}
file: ${{ matrix.component.file }}
platforms: linux/amd64 #,linux/arm64
push: ${{ env.PUSH }}
tags: ghcr.io/netcracker/${{ matrix.component.name }}:${{ env.TAG_NAME }}
provenance: false
- uses: actions/delete-package-versions@v5
with:
package-name: ${{ matrix.component.name }}
package-type: 'container'
package-version-ids: ${{ steps.get-ids-for-delete.outputs.ids-for-delete }}
if: ${{ steps.get-ids-for-delete.outputs.ids-for-delete != '' }}
34 changes: 34 additions & 0 deletions .github/workflows/clean.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Branch Deleted
on: delete

env:
COMPONENT_NAME: pgskipper-monitoring-agent
TAG_NAME: ${{ github.event.ref }}
GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}

jobs:
delete:
if: github.event.ref_type == 'branch'
runs-on: ubuntu-latest
steps:
- name: Prepare Tag
run: echo "TAG_NAME=$(echo ${TAG_NAME} | sed 's@refs/heads/@@;s@/@_@g')" >> $GITHUB_ENV
- name: Login to Docker Hub
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${GITHUB_ACTOR}
password: ${{secrets.GITHUB_TOKEN}}
- name: Get package IDs for delete
id: get-ids-for-delete
uses: Netcracker/[email protected]
with:
component-name: ${{ env.COMPONENT_NAME }}
component-tag: ${{ env.TAG_NAME }}
access-token: ${{ secrets.GH_ACCESS_TOKEN }}
- uses: actions/delete-package-versions@v5
with:
package-name: ${{ env.COMPONENT_NAME }}
package-type: 'container'
package-version-ids: ${{ steps.get-ids-for-delete.outputs.ids-for-delete }}
if: ${{ steps.get-ids-for-delete.outputs.ids-for-delete != '' }}
24 changes: 24 additions & 0 deletions .github/workflows/license.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Add License Header
on:
push:
branches:
- 'main'
env:
COPYRIGHT_COMPANY: 'NetCracker Technology Corporation'
COPYRIGHT_YEAR: '2024-2025'
jobs:
license:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GH_ACCESS_TOKEN }}
- run: docker run -v "${PWD}:/src" -i ghcr.io/google/addlicense -v -c "${{ env.COPYRIGHT_COMPANY }}" -y "${{ env.COPYRIGHT_YEAR }}" $(find . -type f -name "*.go" -o -type f -name "*.sh" -o -type f -name "*.py" | xargs echo)
- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
commit-message: Auto-update license header
branch: license-update
title: Add License Header
body: Automated license header update
delete-branch: true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Build output.
target
/_output/*
73 changes: 73 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Code of Conduct

This repository is governed by following code of conduct guidelines.

We put collaboration, trust, respect and transparency as core values for our community.
Our community welcomes participants from all over the world with different experience,
opinion and ideas to share.

We have adopted this code of conduct and require all contributors to agree with that to build a healthy,
safe and productive community for all.

The guideline is aimed to support a community where all people should feel safe to participate,
introduce new ideas and inspire others, regardless of:

* Age
* Gender
* Gender identity or expression
* Family status
* Marital status
* Ability
* Ethnicity
* Race
* Sex characteristics
* Sexual identity and orientation
* Education
* Native language
* Background
* Caste
* Religion
* Geographic location
* Socioeconomic status
* Personal appearance
* Any other dimension of diversity

## Our Standards

We are welcoming the following behavior:

* Be respectful for different ideas, opinions and points of view
* Be constructive and professional
* Use inclusive language
* Be collaborative and show the empathy
* Focus on the best results for the community

The following behavior is unacceptable:

* Violence, threats of violence, or inciting others to commit self-harm
* Personal attacks, trolling, intentionally spreading misinformation, insulting/derogatory comments
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Derogatory language
* Encouraging unacceptable behavior
* Other conduct which could reasonably be considered inappropriate in a professional community

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of the Code of Conduct
and are expected to take appropriate actions in response to any instances of unacceptable behavior.

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.

## Reporting

If you believe you’re experiencing unacceptable behavior that will not be tolerated as outlined above,
please report to `[email protected]`. 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.

Please also report if you observe a potentially dangerous situation, someone in distress, or violations of these guidelines,
even if the situation is not happening to you.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contribution Guide

We'd love to accept patches and contributions to this project.
Please, follow these guidelines to make the contribution process easy and effective for everyone involved.

## Contributor License Agreement

You must sign the [Contributor License Agreement](https://pages.netcracker.com/cla-main.html) in order to contribute.

## Code of Conduct

Please make sure to read and follow the [Code of Conduct](CODE-OF-CONDUCT.md).
28 changes: 28 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
FROM --platform=$BUILDPLATFORM golang:1.22.5-alpine3.20 as builder

Check warning on line 1 in Dockerfile

View workflow job for this annotation

GitHub Actions / multiplatform_build (pgskipper-monitoring-agent, Dockerfile)

The 'as' keyword should match the case of the 'from' keyword

FromAsCasing: 'as' and 'FROM' keywords' casing do not match More info: https://docs.docker.com/go/dockerfile/rule/from-as-casing/

ENV GO111MODULE=on

# Copy the go source
COPY ./ /workspace

WORKDIR /workspace

RUN go mod tidy

# Build
RUN CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o ./_output/bin/metrics ./collector/main.go

FROM alpine:3.20 as base

Check warning on line 15 in Dockerfile

View workflow job for this annotation

GitHub Actions / multiplatform_build (pgskipper-monitoring-agent, Dockerfile)

The 'as' keyword should match the case of the 'from' keyword

FromAsCasing: 'as' and 'FROM' keywords' casing do not match More info: https://docs.docker.com/go/dockerfile/rule/from-as-casing/
COPY --from=builder --chown=${USER_UID} /workspace/_output/bin/metrics /monitor/

Check warning on line 16 in Dockerfile

View workflow job for this annotation

GitHub Actions / multiplatform_build (pgskipper-monitoring-agent, Dockerfile)

Variables should be defined before their use

UndefinedVar: Usage of undefined variable '$USER_UID' More info: https://docs.docker.com/go/dockerfile/rule/undefined-var/

RUN apk add --upgrade --no-cache curl

RUN chmod +x -R /monitor/ && ln -s /lib /lib64

VOLUME /tmp

EXPOSE 8000 9273

CMD ["/monitor/metrics"]

USER 1001
15 changes: 15 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Security Reporting Process

Please, report any security issue to `[email protected]` where the issue will be triaged appropriately.

If you know of a publicly disclosed security vulnerability please IMMEDIATELY email `[email protected]`
to inform the team about the vulnerability, so we may start the patch, release, and communication process.

# Security Release Process

If the vulnerability is found in the latest stable release, then it would be fixed in patch version for that release.
E.g., issue is found in 2.5.0 release, then 2.5.1 version with a fix will be released.
By default, older versions will not have security releases.

If the issue doesn't affect any existing public releases, the fix for medium and high issues is performed
in a main branch before releasing a new version. For low priority issues the fix can be planned for future releases.
97 changes: 97 additions & 0 deletions collector/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
// Copyright 2024-2025 NetCracker Technology Corporation
//
// 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.

package main

import (
"flag"
"fmt"
"log"
"net/http"
_ "net/http/pprof"
"strconv"
"strings"
"time"

"github.com/Netcracker/pgskipper-monitoring-agent/collector/pkg/initiate"
pgScraper "github.com/Netcracker/pgskipper-monitoring-agent/collector/pkg/metrics"
"github.com/Netcracker/pgskipper-monitoring-agent/collector/pkg/util"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
)

var (
addr = flag.String("localhost", ":9273",
"The address to listen on for HTTP requests.")
timeout = util.GetEnv("METRIC_COLLECTION_INTERVAL", "60")

metrics = make([]string, 0)
)

func collectMetrics(scraper *pgScraper.Scraper) {
log.Printf("Start collecting metrics")

scraper.CollectCommonMetrics()
scraper.CollectMetrics()
scraper.CollectBackupMetrics()

mode := util.GetEnv("METRICS_PROFILE", "prod")
if mode == "dev" {
scraper.CollectPerformanceMetrics()
}

scraper.CollectMetricsFromCM()
metrics = scraper.PrintMetrics()
}

func Metrics(w http.ResponseWriter, r *http.Request) {
log.Printf("metrics gets requested")
fmt.Fprintf(w, "%s", strings.Join(metrics, "\n"))
}

func HttpHandler() {
// Registering our handler functions, and creating paths.
http.HandleFunc("/metrics", Metrics)
log.Println("Started on port", *addr)
// Spinning up the server.
err := http.ListenAndServe(*addr, nil)
if err != nil {
log.Fatal(err)
}
}

func main() {
log.Printf("Init Metric collector")
initiate.InitMetricCollector()
log.Println("Starting http server")
go HttpHandler()

scrapeTimeout, _ := strconv.Atoi(timeout)
protocol, port := util.GetProtocol()
config, err := rest.InClusterConfig()
if err != nil {
panic(err.Error())
}
client, err := kubernetes.NewForConfig(config)
if err != nil {
panic(err.Error())
}

for {
scraper := pgScraper.GetScraper(client, util.GetHttpClient(), protocol, port)
collectMetrics(scraper)
log.Printf("Timeout %v", scrapeTimeout)
time.Sleep(time.Duration(scrapeTimeout) * time.Second)
}
}
Loading

0 comments on commit b97707b

Please sign in to comment.