{"id":32382586,"url":"https://github.com/tech-preta/kubernetes-metrics-api","last_synced_at":"2025-10-25T01:49:10.201Z","repository":{"id":296684652,"uuid":"991640329","full_name":"Tech-Preta/kubernetes-metrics-api","owner":"Tech-Preta","description":"API de métricas Kubernetes que fornece informações sobre o cluster através de endpoints RESTful protegidos por autenticação.","archived":false,"fork":false,"pushed_at":"2025-10-24T21:17:34.000Z","size":35914,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-24T23:19:18.978Z","etag":null,"topics":["go","helm","kubernetes"],"latest_commit_sha":null,"homepage":"https://www.nataliagranato.xyz/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tech-Preta.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"nataliagranato","ko_fi":"nataliagranato","buy_me_a_coffee":"nataliagranato","pix":"fada126d-7311-495f-bda2-55ec79b0a39b"}},"created_at":"2025-05-28T00:03:39.000Z","updated_at":"2025-10-24T21:17:30.000Z","dependencies_parsed_at":"2025-06-01T18:54:49.694Z","dependency_job_id":"5171ca8e-5a26-410c-bf66-f81acbfe89b0","html_url":"https://github.com/Tech-Preta/kubernetes-metrics-api","commit_stats":null,"previous_names":["nataliagranato/k8s-api-metrics","tech-preta/kubernetes-metrics-api"],"tags_count":0,"template":false,"template_full_name":"Tech-Preta/repository-sample","purl":"pkg:github/Tech-Preta/kubernetes-metrics-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Fkubernetes-metrics-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Fkubernetes-metrics-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Fkubernetes-metrics-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Fkubernetes-metrics-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tech-Preta","download_url":"https://codeload.github.com/Tech-Preta/kubernetes-metrics-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tech-Preta%2Fkubernetes-metrics-api/sbom","scorecard":{"id":1166326,"data":{"date":"2025-08-28T19:01:29Z","repo":{"name":"github.com/nataliagranato/k8s-api-metrics","commit":"f725404735d4dc8a182a589761aaebad9f9f8977"},"scorecard":{"version":"v5.2.1","commit":"ab2f6e92482462fe66246d9e32f642855a691dc1"},"score":5.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/7 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":10,"reason":"26 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#maintained"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#security-policy"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: Dependabot: .github/dependabot.yml:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#dependency-update-tool"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/dependabot.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/dependency-review.yml:13","Info: topLevel 'contents' permission set to 'read': .github/workflows/issue.yml:7","Warn: topLevel 'security-events' permission set to 'write': .github/workflows/osv-scanner.yml:26","Info: topLevel 'contents' permission set to 'read': .github/workflows/osv-scanner.yml:28","Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:18","Warn: topLevel 'contents' permission set to 'write': .github/workflows/trivy.yml:9","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/trivy.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nataliagranato/k8s-api-metrics/trivy.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/trivy.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/nataliagranato/k8s-api-metrics/trivy.yml/main?enable=pin","Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:1: pin your Docker image by updating mcr.microsoft.com/vscode/devcontainers/base:ubuntu-22.04 to mcr.microsoft.com/vscode/devcontainers/base:ubuntu-22.04@sha256:e57fdff274ed0bac0776490fa2644c242491bb21d4df7ad0bb79b433eac5168d","Warn: containerImage not pinned by hash: Dockerfile:4","Warn: containerImage not pinned by hash: Dockerfile:27: pin your Docker image by updating alpine:3.19 to alpine:3.19@sha256:3be987e6cde1d07e873c012bf6cfe941e6e85d16ca5fc5b8bedc675451d2de67","Warn: downloadThenRun not pinned by hash: .devcontainer/Dockerfile:38","Warn: pipCommand not pinned by hash: .devcontainer/Dockerfile:77-80","Warn: downloadThenRun not pinned by hash: .devcontainer/Dockerfile:83","Warn: downloadThenRun not pinned by hash: .devcontainer/Dockerfile:106","Warn: downloadThenRun not pinned by hash: .devcontainer/Dockerfile:110","Warn: downloadThenRun not pinned by hash: .devcontainer/Dockerfile:128-130","Info:   5 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   5 out of   6 third-party GitHubAction dependencies pinned","Info:   0 out of   3 containerImage dependencies pinned","Info:   0 out of   5 downloadThenRun dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#branch-protection"}},{"name":"Contributors","score":3,"reason":"project has 1 contributing companies or organizations -- score normalized to 3","details":["Info: found contributions from: ifood"],"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#contributors"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#sast"}},{"name":"CI-Tests","score":10,"reason":"17 out of 17 merged PRs checked by a CI test -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/ab2f6e92482462fe66246d9e32f642855a691dc1/docs/checks.md#ci-tests"}}]},"last_synced_at":"2025-08-28T20:57:33.426Z","repository_id":296684652,"created_at":"2025-08-28T20:57:33.427Z","updated_at":"2025-08-28T20:57:33.427Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280893644,"owners_count":26409279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","helm","kubernetes"],"created_at":"2025-10-25T01:48:24.269Z","updated_at":"2025-10-25T01:49:10.195Z","avatar_url":"https://github.com/Tech-Preta.png","language":"Go","funding_links":["https://github.com/sponsors/nataliagranato","https://ko-fi.com/nataliagranato","https://buymeacoffee.com/nataliagranato","fada126d-7311-495f-bda2-55ec79b0a39b"],"categories":[],"sub_categories":[],"readme":"# Kubernetes API Metrics\n\nAPI de métricas Kubernetes que fornece informações sobre o cluster através de endpoints RESTful protegidos por autenticação.\n\n## Índice\n\n- [Kubernetes API Metrics](#kubernetes-api-metrics)\n  - [Índice](#índice)\n  - [Visão Geral](#visão-geral)\n  - [Requisitos](#requisitos)\n    - [Dependências](#dependências)\n  - [Histórico de Versões](#histórico-de-versões)\n    - [v1.0.1 (27 de maio de 2025)](#v101-27-de-maio-de-2025)\n      - [Detalhes da correção na v1.0.1](#detalhes-da-correção-na-v101)\n  - [Desenvolvimento Local](#desenvolvimento-local)\n    - [Compilar e Executar](#compilar-e-executar)\n    - [Testar Localmente](#testar-localmente)\n  - [Docker](#docker)\n    - [Build da Imagem](#build-da-imagem)\n    - [Executar com Docker](#executar-com-docker)\n    - [Publicar Imagem no Registry](#publicar-imagem-no-registry)\n  - [Kubernetes](#kubernetes)\n    - [Deploy com Helm](#deploy-com-helm)\n    - [Acessar a API no Kubernetes](#acessar-a-api-no-kubernetes)\n    - [Atualizar o Deployment](#atualizar-o-deployment)\n    - [Troubleshooting](#troubleshooting)\n  - [Endpoints da API](#endpoints-da-api)\n    - [Exemplos de Resposta](#exemplos-de-resposta)\n      - [`/metrics` (JSON)](#metrics-json)\n      - [`/healthz` (Health Check)](#healthz-health-check)\n  - [Autenticação](#autenticação)\n  - [Observações e Melhorias](#observações-e-melhorias)\n  - [Contribuindo](#contribuindo)\n    - [Validação e Testes](#validação-e-testes)\n      - [1. Teste Local com Go](#1-teste-local-com-go)\n      - [2. Teste com Docker](#2-teste-com-docker)\n      - [3. Teste com Kubernetes](#3-teste-com-kubernetes)\n    - [Convenções de Código](#convenções-de-código)\n\n## Visão Geral\n\nEsta API é desenvolvida em Go e coleta métricas do cluster Kubernetes onde está sendo executada. Ela fornece informações como:\n\n- Contagem de nós, pods, deployments e serviços\n- Informações detalhadas sobre cada nó\n- Status dos componentes do cluster\n\nOs dados são disponibilizados em formato JSON e também em formato Prometheus para monitoramento.\n\n## Requisitos\n\n- Go 1.24 ou superior (para desenvolvimento local)\n- Docker (para build da imagem)\n- Kubernetes (para deploy)\n- Helm 3.x (para deploy usando o chart)\n- Acesso a um cluster Kubernetes (para teste e implantação)\n\n### Dependências\n\nO projeto utiliza as seguintes dependências principais:\n\n```go\n// Arquivo go.mod\nrequire (\n\tgithub.com/prometheus/client_golang v1.22.0\n\tk8s.io/apimachinery v0.33.1\n\tk8s.io/client-go v0.33.1\n)\n```\n\nPara instalar todas as dependências, execute `go mod download` no diretório do projeto.\n\n## Histórico de Versões\n\n- **v1.0.0** - Lançamento inicial da API com métricas básicas do cluster.\n- **v1.0.1** - Melhoria na validação do token de autenticação e atualização na documentação\n\n### v1.0.1 (27 de maio de 2025)\n- Corrigido problema de autenticação que rejeitava tokens válidos\n- Adicionado `strings.TrimSpace()` para remover quebras de linha e espaços indesejados no token\n- Configurado uso de variável de ambiente `EXPECTED_AUTH_TOKEN` para maior flexibilidade\n- Melhorada a documentação e exemplos de uso\n\n#### Detalhes da correção na v1.0.1\n\nO principal problema resolvido na versão v1.0.1 foi a rejeição incorreta de tokens de autenticação válidos. A causa-raiz era:\n\n1. O token armazenado no Secret Kubernetes tinha uma quebra de linha extra (`\\n`) no final\n2. A API não removia espaços em branco ou quebras de linha do token lido da variável de ambiente\n\nA solução implementada foi:\n```go\n// main.go - Função main()\n// Configura o token de autenticação a partir da variável de ambiente\nexpectedAuthToken = os.Getenv(\"EXPECTED_AUTH_TOKEN\")\nif expectedAuthToken == \"\" {\n    logger.Error(\"Variável de ambiente EXPECTED_AUTH_TOKEN não definida. Defina um token de autenticação.\")\n    os.Exit(1)\n}\n// Remove qualquer quebra de linha ou espaço em branco do token\nexpectedAuthToken = strings.TrimSpace(expectedAuthToken)\nlogger.Info(\"Token de autenticação configurado com sucesso.\")\n```\n\nEsta mudança garante que tokens com quebras de linha ou espaços em branco indesejados ainda funcionem corretamente.\n\n## Desenvolvimento Local\n\n### Compilar e Executar\n\nPara compilar e executar a aplicação localmente:\n\n```bash\n# Clone o repositório\ngit clone https://github.com/nataliagranato/k8s-api-metrics.git\ncd k8s-api-metrics\n\n# Baixe as dependências\ngo mod download\ngo mod verify\n\n# Compile o código\ngo build -o k8s-api-metrics .\n\n# Configure o token de autenticação\nexport EXPECTED_AUTH_TOKEN=\"meuTokenSuperSeguro123!@#\"\n\n# Execute a aplicação (usa o kubeconfig do seu $HOME/.kube/config)\n./k8s-api-metrics\n```\n\n### Testar Localmente\n\nEm outro terminal, teste os endpoints da API:\n\n```bash\n# Teste o endpoint de health check (não requer autenticação)\ncurl http://localhost:8080/healthz\n\n# Teste o endpoint de métricas JSON (requer autenticação)\ncurl -H 'Authorization: Bearer meuTokenSuperSeguro123!@#' http://localhost:8080/metrics\n\n# Teste o endpoint de métricas Prometheus (requer autenticação)\ncurl -H 'Authorization: Bearer meuTokenSuperSeguro123!@#' http://localhost:8080/prometheus\n```\n\n## Docker\n\n### Build da Imagem\n\nPara construir a imagem Docker:\n\n```bash\n# Build da imagem\ndocker build -t nataliagranato/k8s-api-metrics:v1.0.1 .\n\n# Verificar se a imagem foi criada\ndocker images | grep k8s-api-metrics\n```\n\n### Executar com Docker\n\nPara executar a aplicação usando Docker:\n\n```bash\n# Executar o container Docker\ndocker run -p 8080:8080 -e EXPECTED_AUTH_TOKEN=\"meuTokenSuperSeguro123!@#\" nataliagranato/k8s-api-metrics:v1.0.1\n\n# Para execução em modo detached (background)\ndocker run -d -p 8080:8080 -e EXPECTED_AUTH_TOKEN=\"meuTokenSuperSeguro123!@#\" nataliagranato/k8s-api-metrics:v1.0.1\n```\n\nObservação: Para que o container acesse o cluster Kubernetes, você precisará montar o arquivo kubeconfig ou executar o container dentro de um pod no cluster.\n\n### Publicar Imagem no Registry\n\nPara publicar a imagem no Docker Hub ou outro registry:\n\n```bash\n# Login no Docker Hub\ndocker login\n\n# Push da imagem\ndocker push nataliagranato/k8s-api-metrics:v1.0.1\n```\n\n## Kubernetes\n\n### Deploy com Helm\n\nPara implantar a aplicação no Kubernetes usando Helm:\n\n```bash\n# Navegue até a pasta do projeto\ncd k8s-api-metrics\n\n# Crie um namespace para a aplicação\nkubectl create namespace k8s-api-metrics\n\n# Instale o chart Helm\nhelm install k8s-api-metrics ./charts/k8s-api-metrics -n k8s-api-metrics\n```\n\nPara personalizar a instalação, você pode editar o arquivo `charts/k8s-api-metrics/values.yaml` ou usar o parâmetro `--set`:\n\n```bash\nhelm install k8s-api-metrics ./charts/k8s-api-metrics -n k8s-api-metrics \\\n  --set application.authToken=\"seuTokenPersonalizado\" \\\n  --set replicaCount=2\n```\n\n### Acessar a API no Kubernetes\n\nApós a instalação, você pode acessar a API usando port-forward:\n\n```bash\n# Port-forward para acessar o serviço localmente\nkubectl port-forward svc/k8s-api-metrics-k8s-api-metrics 8080:8080 -n k8s-api-metrics\n\n# Em outro terminal, acesse a API com o token\ncurl -H 'Authorization: Bearer meuTokenSuperSeguro123!@#' http://localhost:8080/metrics\n```\n\nOu, se você configurou um Ingress, através do hostname configurado.\n\n### Atualizar o Deployment\n\nPara atualizar a aplicação para uma nova versão:\n\n```bash\n# Edite o arquivo values.yaml para atualizar a tag da imagem\n# Em seguida, atualize o deployment\nhelm upgrade k8s-api-metrics ./charts/k8s-api-metrics -n k8s-api-metrics\n\n# Verificar o status da atualização\nkubectl get pods -n k8s-api-metrics\n```\n\n### Troubleshooting\n\nPara diagnosticar problemas:\n\n```bash\n# Verificar os pods\nkubectl get pods -n k8s-api-metrics\n\n# Verificar os logs do pod\nkubectl logs -n k8s-api-metrics $(kubectl get pods -n k8s-api-metrics -o jsonpath='{.items[0].metadata.name}')\n\n# Verificar o Secret com o token\nkubectl get secret -n k8s-api-metrics k8s-api-metrics-k8s-api-metrics-auth-token -o jsonpath='{.data.auth-token}' | base64 --decode\n\n# Verificar o token dentro do pod\nkubectl exec -it -n k8s-api-metrics $(kubectl get pods -n k8s-api-metrics -o jsonpath='{.items[0].metadata.name}') -- sh\necho \"$EXPECTED_AUTH_TOKEN\"\n```\n\n## Endpoints da API\n\nA API expõe os seguintes endpoints:\n\n- `/metrics` - Métricas em formato JSON (requer autenticação)\n- `/prometheus` - Métricas em formato Prometheus (requer autenticação)\n- `/healthz` - Endpoint de health check (não requer autenticação)\n\n### Exemplos de Resposta\n\n#### `/metrics` (JSON)\n\n```json\n{\n  \"nodeCount\": 1,\n  \"podCount\": 10,\n  \"deploymentCount\": 3,\n  \"serviceCount\": 3,\n  \"nodes\": [\n    {\n      \"name\": \"kind-control-plane\",\n      \"status\": \"Ready\",\n      \"allocatableCpu\": \"12\",\n      \"allocatableMemory\": \"16053964Ki\",\n      \"kubeletVersion\": \"v1.30.0\",\n      \"osImage\": \"Debian GNU/Linux 12 (bookworm)\",\n      \"labels\": {\n        \"beta.kubernetes.io/arch\": \"amd64\",\n        \"beta.kubernetes.io/os\": \"linux\",\n        \"kubernetes.io/arch\": \"amd64\",\n        \"kubernetes.io/hostname\": \"kind-control-plane\",\n        \"kubernetes.io/os\": \"linux\",\n        \"node-role.kubernetes.io/control-plane\": \"\"\n      }\n    }\n  ],\n  \"timestamp\": \"2025-05-27T23:42:58.553630851Z\"\n}\n```\n\n#### `/healthz` (Health Check)\n\n```json\n{\n  \"status\": \"ok\",\n  \"timestamp\": \"2025-05-27T23:43:15Z\"\n}\n```\n\n## Autenticação\n\nA API utiliza autenticação baseada em token usando o header HTTP `Authorization`.\n\nExemplo:\n```\nAuthorization: Bearer meuTokenSuperSeguro123!@#\n```\n\nO token esperado é configurado através da variável de ambiente `EXPECTED_AUTH_TOKEN` no container.\n\n## Observações e Melhorias\n\n- A partir da versão v1.0.1, a aplicação utiliza `strings.TrimSpace()` para remover quebras de linha ou espaços em branco indesejados no token de autenticação, evitando problemas comuns com tokens inválidos.\n- Para ambientes de produção, recomenda-se usar um Secret existente (opção 2 na configuração do Helm) e não definir o token diretamente no values.yaml.\n- A API está configurada para coletar métricas básicas do cluster. Para métricas mais avançadas, seria necessário integrar com o Metrics Server ou o Prometheus.\n\n## Contribuindo\n\nPara contribuir com o projeto:\n\n1. Faça um fork do repositório\n2. Crie uma branch para sua feature (`git checkout -b feature/nova-feature`)\n3. Implemente suas alterações\n4. Execute os testes (se houver)\n5. Faça commit das alterações (`git commit -m 'Adiciona nova feature'`)\n6. Faça push para a branch (`git push origin feature/nova-feature`)\n7. Abra um Pull Request\n\n### Validação e Testes\n\nPara validar que suas alterações funcionam corretamente, siga estes passos:\n\n#### 1. Teste Local com Go\n\n```bash\n# Execute a aplicação localmente\nexport EXPECTED_AUTH_TOKEN=\"meuTokenSuperSeguro123!@#\"\ngo run main.go\n```\n\nEm outro terminal:\n```bash\n# Teste o endpoint de health\ncurl http://localhost:8080/healthz\n\n# Teste o endpoint de métricas com autenticação\ncurl -H 'Authorization: Bearer meuTokenSuperSeguro123!@#' http://localhost:8080/metrics\n```\n\n#### 2. Teste com Docker\n\n```bash\n# Construa a imagem\ndocker build -t nataliagranato/k8s-api-metrics:latest .\n\n# Execute o container\ndocker run -p 8080:8080 -e EXPECTED_AUTH_TOKEN=\"meuTokenSuperSeguro123!@#\" nataliagranato/k8s-api-metrics:latest\n```\n\n#### 3. Teste com Kubernetes\n\n```bash\n# Deploy com Helm\nhelm install k8s-api-metrics ./charts/k8s-api-metrics -n k8s-api-metrics --create-namespace\n\n# Verifique os pods\nkubectl get pods -n k8s-api-metricstrimando\n\n# Port-forward\nkubectl port-forward svc/k8s-api-metrics-k8s-api-metrics 8080:8080 -n k8s-api-metrics\n\n# Teste a API\ncurl -H 'Authorization: Bearer meuTokenSuperSeguro123!@#' http://localhost:8080/metrics\n```\n\n\n### Convenções de Código\n\n- Siga as [convenções de código Go](https://golang.org/doc/effective_go)\n- Use `gofmt` para formatar seu código\n- Adicione comentários explicativos para funções e estruturas complexas\n- Mantenha a documentação atualizada\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftech-preta%2Fkubernetes-metrics-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftech-preta%2Fkubernetes-metrics-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftech-preta%2Fkubernetes-metrics-api/lists"}