{"id":26047672,"url":"https://github.com/prawucki/watch-logs","last_synced_at":"2025-03-07T23:12:54.306Z","repository":{"id":280186222,"uuid":"929482158","full_name":"Prawucki/watch-logs","owner":"Prawucki","description":"Middleware for Log Validation","archived":false,"fork":false,"pushed_at":"2025-03-01T19:07:14.000Z","size":62,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-01T20:46:27.620Z","etag":null,"topics":["express","express-js","expressjs","graylog","graylog-api","graylog-rest-api","graylog2","middleware","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Prawucki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-08T16:46:48.000Z","updated_at":"2025-03-01T19:24:56.000Z","dependencies_parsed_at":"2025-03-01T20:46:35.310Z","dependency_job_id":"a2f3d8cf-f2af-47ed-b5ef-88df2e1a2657","html_url":"https://github.com/Prawucki/watch-logs","commit_stats":null,"previous_names":["prawucki/watch-logs"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Prawucki%2Fwatch-logs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Prawucki%2Fwatch-logs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Prawucki%2Fwatch-logs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Prawucki%2Fwatch-logs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Prawucki","download_url":"https://codeload.github.com/Prawucki/watch-logs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242473054,"owners_count":20134020,"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","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":["express","express-js","expressjs","graylog","graylog-api","graylog-rest-api","graylog2","middleware","typescript"],"created_at":"2025-03-07T23:12:53.727Z","updated_at":"2025-03-07T23:12:54.300Z","avatar_url":"https://github.com/Prawucki.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Watch logs\n\nÉ um software criado para ser um middleware entre aplicações e o [Graylog](https://graylog.org/), tratando e validando as entradas e saídas.\nConstruído com [Express](https://expressjs.com/), [Typescript](https://www.typescriptlang.org/) e [Zod](https://zod.dev/) para schemas de validação.\n\n### Utilização\n\n###### Para executar esse projeto você precisa das seguintes variáveis, ou no ambiente ou no `.env` na raiz do projeto:\n\n| Nome | Tipo    | Valor Padrão | Valores permitidos         | Descrição                              |\n| :-------- | :------ | :------- | :-------------- | :------------------------------------- |\n| `NODE_ENV` | `string`| `development` | `development`/`production` | **Obrigatório**.|\n| `PORT` | `string`| `3000` |  | **Obrigatório**. Porta para este projeto executar.|\n| `GRAYLOG_HOST` | `string`|  |  | **Obrigatório**. Apenas o nome, ou FQDN, do Graylog.|\n\n#### Modos de execução:\n\nDesenvolvimento:\n```command\nnpm install\nnpm run dev\n```\n\nProdução:\n```command\nnpm install\nnpm run build\nnpm run start\n```\n\nDocker:\n```command\ndocker build -t watch-logs:1.0.0 .\ndocker run --name watch-logs \\\n  --env NODE_ENV=production \\\n  --env PORT=3000 \\\n  --env GRAYLOG_HOST=graylog.exemplo.com.br \\\n  watch-logs:1.0.0\n```\n\n\u003e ###### Para utilizar o método GET é necessário enviar um token de autorização do tipo Basic com a senha `token`, como se fosse utilizar o próprio Graylog pois de forma padrão ele funciona assim. Inclusive a geração ou revogação desses tokens fica no prórpio Graylog. Este middleware apenas repassa essa informação.\n\n\u003e ###### `logType` disponíveis:\n\u003e - erp_homologation\n\u003e - erp_production\n\u003e - system_homologation\n\u003e - system_production\n\n#### Retorna todos os logs de um input\n\n```http\nGET /logs/${logType}\n```\n\n| Parâmetro | Tipo    | Exemplo         | Descrição                              |\n| :-------- | :------ | :-------------- | :------------------------------------- |\n| `logType` | `string`| erp_homologation | **Obrigatório**. O input que você quer.|\n\n#### Retorna logs de uma faixa temporal de um input\n\n```http\nGET /logs/${logType}?from=${from}\u0026to=${to}\n```\n\n| Parâmetro | Tipo      | Exemplo                | Descrição                    |\n| :-------- | :-------- | :--------------------- | :--------------------------- |\n| `from`    | `datetime`| 2024-12-12T21:03:58.340Z| A data, hora e segundo inicial.|\n| `to`      | `datetime`| 2024-12-12T21:04:51.320Z| A data, hora e segundo final. |\n\n#### Retorna logs dos últimos X tempo até agora de um input\n\n```http\nGET /logs/${logType}?range=${range}\n```\n\n| Parâmetro | Tipo    | Exemplo | Descrição           |\n| :-------- | :------ | :------ | :------------------ |\n| `range`   | `number`| 300     | Tempo em segundos.  |\n\n#### Retorna logs filtrados por um campo de um input\n\n```http\nGET /logs/${logType}?${field}=${value}\n```\n\n| Parâmetro | Tipo    | Exemplo | Descrição       |\n| :-------- | :------ | :------ | :-------------- |\n| `field`   | `string`| trace_id| Campo do log.   |\n| `value`   | `any`   | 1234    | Valor do campo. |\n\n\u003e Você pode mesclar os filtros de retorno, por exemplo, faixa temporal com campo_a e campo_b.\n\u003e\u003e Ao utilizar o filtro de faixa temporal a consulta será tratada como absoluta, ou seja, ignorará o parâmetro range.\n\u003e\u003e Ao utilizar o filtro sem faixa temporal a consulta será tratada como relativa, retornando todos os resultados existentes se um range não for informado.\n\n#### Grava logs em um input\n\n```http\nPOST /logs/${logType}\n```\n\n| Parâmetro | Tipo    | Exemplo         | Descrição                              |\n| :-------- | :------ | :-------------- | :------------------------------------- |\n| `logType` | `string`| erp_homologation | **Obrigatório**. O input que você quer.|\n\n### Exemplos\n\n###### Query params para `cod_erp` em uma faixa temporal:\n\n```\nhttps://graylog.exemplo.com.br/logs/erp_homologation?from=2024-12-12T21:03:58.340Z\u0026to=2024-12-12T21:04:51.320Z\u0026cod_erp=0000\n```\n\n###### Payload para `erp_homologation` ou `erp_production`:\n\n```json\n{\n    \"host\": \"origem\",\n    \"short_message\": \"mensagem curta e objetiva\",\n    \"level\": 6,\n    \"full_message\": \"mensagem completa e detalhada\",\n    \"trace_id\": 123456789,\n    \"cod_erp\": \"0000\",\n    \"additional_fields\": {\n        \"sistema\": \"web\",\n        \"linha\": 10,\n        \"credencial_usada\": \"usuario_impessoal\"\n    }\n}\n```\n\n\u003e Esses campos, com excessão do `additional_fields`, são obrigatórios. Não é permitido enviar qualquer outro campo se ele não estiver dentro de `additional_fields`.\n\n###### Payload para `system_homologation` ou `system_production`:\n\n```json\n{\n    \"host\": \"origem\",\n    \"short_message\": \"mensagem curta e objetiva\",\n    \"level\": 6,\n    \"full_message\": \"mensagem completa e detalhada\",\n    \"additional_fields\": {\n        \"modulo\": \"orchestrator\",\n        \"role\": \"viewer\",\n        \"user_id\": 1234\n    }\n}\n```\n\n\u003e Esses campos, com excessão do `additional_fields`, são obrigatórios. Não é permitido enviar qualquer outro campo se ele não estiver dentro de `additional_fields`.\n\n### Mantenabilidade\n\nNos arquivos `/src/constants/logType.ts` e `/src/types/LogType.ts` ficam os nomes disponíveis para input.\n\nNo arquivo `/src/utils/logTypeConfig.ts` fica o cruzamento entre o nome do input especificado e o endpoint real do Graylog.\n\nOs inputs no Graylog precisam ser do tipo `GELF HTTP` porque é o que está especificado em `/src/services/registerLogs.ts`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprawucki%2Fwatch-logs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprawucki%2Fwatch-logs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprawucki%2Fwatch-logs/lists"}