{"id":15044692,"url":"https://github.com/eduzz/judas","last_synced_at":"2025-10-24T08:31:12.163Z","repository":{"id":53766892,"uuid":"168385803","full_name":"eduzz/judas","owner":"eduzz","description":null,"archived":false,"fork":false,"pushed_at":"2022-07-11T14:42:17.000Z","size":122,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-01-31T00:33:32.484Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/eduzz.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}},"created_at":"2019-01-30T17:35:16.000Z","updated_at":"2022-06-14T22:02:55.000Z","dependencies_parsed_at":"2022-09-10T12:50:38.079Z","dependency_job_id":null,"html_url":"https://github.com/eduzz/judas","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fjudas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fjudas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fjudas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fjudas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eduzz","download_url":"https://codeload.github.com/eduzz/judas/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237937790,"owners_count":19390543,"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":[],"created_at":"2024-09-24T20:50:55.052Z","updated_at":"2025-10-24T08:31:11.875Z","avatar_url":"https://github.com/eduzz.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Judas\n\nO Judas é uma library de logs, é uma implementação que utiliza a lib **[Hermes](https://bitbucket.org/eduzz/hermes)** para enviar os logs para o **rabbitMQ**, e então, utiliza um método store que armazena os logs no **elasticSearch**.\n\n## Instalação\n\nPrimeiro, vamos adicionar a dependência e o repositório do **Judas** e do **Hermes** no nosso arquivo composer.json:\n\n```json\n{\n    \"require\": {\n        \"eduzz/hermes\": \"dev-master\",\n        \"eduzz/judas\": \"dev-master\"\n    },\n    \"repositories\": [\n        {\n            \"type\": \"vcs\",\n            \"url\":  \"git@bitbucket.org:eduzz/hermes.git\"\n        },\n                {\n            \"type\": \"vcs\",\n            \"url\":  \"git@bitbucket.org:eduzz/judas.git\"\n        }\n    ]\n}\n```\n\nApós, vamos rodar o comando\n\n```\ncomposer dump-autoload\n```\n\nPara atualizar o cache do composer\n\n```\ncomposer install\n```\n\nPara instalar as dependência e o judas\n\nPS: É preciso verificar se você está com a chave conectada ao bitbucket no shell onde vai rodar o composer install.\n\n### Instalação em projeto Laravel\n\nO próximo passo é registrar o Judas na lista de service providers, dentro do seu config/app.php, adicione o Judas na sua lista de providers e adicione também a facade do Judas na lista de aliases.\n\n ```php\n'providers'  =\u003e [\n\t// ...\n\tEduzz\\Judas\\JudasLaravelServiceProvider::class,\n],\n```\n\n```php\n'aliases'  =\u003e [\n\t// ...\n\t'Judas'  =\u003e  Eduzz\\Judas\\Facades\\JudasFacade::class,\n],\n```\n\nPrecisamos limpar nosso cache, atualizar os pacotes e publicar a configuração do Judas:\n\n```bash\nphp artisan cache:config\ncomposer update\nphp artisan vendor:publish --tag=\"config\"\n```\n\nSe tudo ocorreu bem, a seguinte mensagem sera exibida:\n\n```bash\nCopied File [/vendor/eduzz/judas/src/Config/judas.php] To [/config/judas.php]\n```\n\nEntão, é necessário configurar o judas, no arquivo config/judas.php, nas variáveis elastic_connection, queue_connection e environment, por exemplo:\n\n```php\n// Caso seja apenas store\n'elastic_connection'  =\u003e  array(\n\t'host'  =\u003e  env('JUDAS_ELASTIC_HOST'),\n\t'port'  =\u003e  env('JUDAS_ELASTIC_PORT'),\n\t'username'  =\u003e  env('JUDAS_ELASTIC_USERNAME'),\n\t'password'  =\u003e  env('JUDAS_ELASTIC_PASSWORD')\n),\n\n// Caso seja para logar\n'queue_connection'  =\u003e  array(\n\t'host'  =\u003e  env('JUDAS_QUEUE_HOST'),\n\t'port'  =\u003e  env('JUDAS_QUEUE_PORT'),\n\t'username'  =\u003e  env('JUDAS_QUEUE_USERNAME'),\n\t'password'  =\u003e  env('JUDAS_QUEUE_PASSWORD')\n),\n\n'environment' =\u003e 'development'\n```\n\n### Instalação em projeto Lumen\n\nPara instalação em projeto lumen, é preciso criar o arquivo de configuração na mão, vamos adicionar um arquivo chamado judas.php na pasta config com o seguinte conteúdo:\n\n```php\n// Caso seja apenas store\n'elastic_connection'  =\u003e  array(\n\t'host'  =\u003e  env('JUDAS_ELASTIC_HOST'),\n\t'port'  =\u003e  env('JUDAS_ELASTIC_PORT'),\n\t'username'  =\u003e  env('JUDAS_ELASTIC_USERNAME'),\n\t'password'  =\u003e  env('JUDAS_ELASTIC_PASSWORD')\n),\n\n// Caso seja para logar\n'queue_connection'  =\u003e  array(\n\t'host'  =\u003e  env('JUDAS_QUEUE_HOST'),\n\t'port'  =\u003e  env('JUDAS_QUEUE_PORT'),\n\t'username'  =\u003e  env('JUDAS_QUEUE_USERNAME'),\n\t'password'  =\u003e  env('JUDAS_QUEUE_PASSWORD'),\n\t'connection_name' =\u003e env('JUDAS_QUEUE_CONNECTION_NAME'),\n),\n\n'environment' =\u003e 'development'\n```\n\nVamos também adicionar nosso service provider no register, então na pasta bootstrap/app.php, procure pela linha que faz os registros e adicione:\n\n```php\n\u003c?php\n// ...\n$app-\u003eregister(Eduzz\\Judas\\JudasLaravelServiceProvider::class);\n// ...\n```\n\nAdicione também a chamada para a configuração do judas, por exemplo:\n\n```php\n\u003c?php\n$app-\u003econfigure('judas');\n\nreturn $app;\n```\n\n### Instalação em um projeto sem framework Illuminate\n\nPara utilizar o Judas sem Laravel/Lumen, é necessário setar as configurações na mão, exemplo:\n\n```php\n\u003c?php\n\nrequire_once __DIR__ . '/vendor/autoload.php';\nuse Eduzz\\Judas\\Judas;\n\n$judas = new Judas();\n\n$judas-\u003esetQueueConfig([\n    'host' =\u003e 'localhost',\n    'port' =\u003e 5672,\n    'username' =\u003e 'guest',\n    'password' =\u003e 'guest',\n    'vhost' =\u003e '/'\n]);\n\n// Caso você vá utilizar o store\n$judas-\u003esetKeeperConfig([\n    'host' =\u003e 'localhost',\n    'port' =\u003e 9200,\n    'username' =\u003e 'elastic',\n    'password' =\u003e 'elastic',\n]);\n\n$judas-\u003eenvironment = 'development';\n```\n\n### Sobre o parâmetro environment\n\nO parâmetro environment define para qual index do elastic search a mensagem vai na hora de fazer o store.\n\nO environment padrão é o production, que envia para o index history, quando setamos qualquer outro environment que não seja production, o index para onde o log vai é:\n\nhistory-\"Environment que foi definido\"\n\n# Usage\n\n## Logando\n\nTodos os logs do judas viram mensagens do hermes, que são enviadas para o routingKey \"judas.store.info\".\n\n### Logando mensagens com Laravel/Lumen\n\nVamos utilizar a injeção de dependência do laravel para instanciar o Judas já pegando as configurações do arquivo config/judas.php, exemplo de um controller do laravel utilizando o judas:\n\n```php\n\u003c?php\n\nnamespace App\\Http\\Controllers;\n\nuse Illuminate\\Routing\\Controller as BaseController;\nuse Eduzz\\Judas\\Judas;\n\nclass Controller extends BaseController\n{\n\tprivate $judas;\n\n\tpublic function  __construct(Judas  $judas) {\n\t\t$this-\u003ejudas  =  $judas;\n\n\t\tparent::__construct();\n\t}\n\n\tpublic function  method() {\n\t\t// Sua lógica aqui\n\n\t\t$this-\u003ejudas-\u003elog(\n\t\t\t// app.module.action\n\t\t\t'myeduzzleg.user.login',\n\t\t\t[\n\t\t\t\t'agent'  =\u003e  'user',\n\t\t\t\t'event.data.id'  =\u003e  999,\n\t\t\t\t'user.id'  =\u003e  999,\n\t\t\t\t'user.name'  =\u003e  \"angelorodriigo.rs@gmail.com\",\n\t\t\t\t'user.ip'  =\u003e  \"127.0.0.1\",\n\t\t\t\t'additional_data.status'  =\u003e  'success'\n\t\t\t]\n\t\t);\n\t}\n}\n```\n\n### Logando mensagens sem framework Illuminate\n\nPara logar algo sem utilizarmos um framework Illuminate, vamos utilizar algum objeto que já setou as configurações e logar da maneira comum.\n\n```php\n\u003c?php\n\nrequire_once __DIR__ . '/vendor/autoload.php';\nuse Eduzz\\Judas\\Judas;\n\n$judas = new Judas();\n\n$judas-\u003esetQueueConfig([\n    'host' =\u003e 'localhost',\n    'port' =\u003e 5672,\n    'username' =\u003e 'guest',\n    'password' =\u003e 'guest',\n\t'vhost' =\u003e '/',\n\t'connection_name' =\u003e null,\n]);\n\n$judas-\u003eenvironment = 'development';\n\n$judas-\u003elog(\n\t// app.module.action\n\t'myeduzzleg.user.login',\n\t[\n\t\t'agent'  =\u003e  'user',\n\t\t'event.data.id'  =\u003e  999,\n\t\t'user.id'  =\u003e  999,\n\t\t'user.name'  =\u003e  \"angelorodriigo.rs@gmail.com\",\n\t\t'user.ip'  =\u003e  \"127.0.0.1\",\n\t\t'additional_data.status'  =\u003e  'success'\n\t]\n);\n```\n\n### Tipagem\n\nOs logs do judas são tipados, temos alguns paramêtros obrigatórios e outros não, e temos também parâmetros que são obrigatórios e precisam ser de um valor \"x\".\n\nAlguns valores não obrigatórios são recomendados para melhor controle.\n\nOs valores do primeiro parâmetro passado, a string, corresponde a:\n\n```\napp.module.action\n```\n\nOu seja, esses valores não precisam ser passados no array, como no exemplo demonstrado acima.\n___\n\n#### Tabela de parâmetros do array de dados\n\n| Parâmetro | Obrigatório | Valores aceitos |\n|--|--|--|\n| agent | sim | \"procedure\", \"system\", \"user\" ou \"support\" |\n| app | sim | \"cktsun\", \"orbita\", \"myeduzz\", \"cktleg\", \"myeduzzleg\", \"nutror\" ou \"next\"  |\n| module | sim | quaisquer |\n| action | sim | quaisquer |\n| user.id | não | inteiro ou string |\n| user.ip | não | string\n| user.name | não | string |\n| user.email | não | string |\n| support.id | não | inteiro ou string |\n| support.ip | não | string\n| support.name | não | string |\n| support.email | não | string |\n| system.ip | não | string\n\n\n## Armazenando logs no elastic search\n\nOs logs do Judas são enviados para uma fila, então, um worker processa os logs e os envia para o elastic search.\n\n### Armazenando logs\n\nNo armazenamento do log são necessários alguns parâmetros, como index e date, precisa ser passado um json para o método store.\n\n```php\n\u003c?php\n\n$judas-\u003estore(\n\tjson_encode(\n\t\t[\n\t\t\t\"index\" =\u003e 'history',\n\t\t\t\"event\" =\u003e [\n\t\t\t\t\"date\" =\u003e \"2018-05-14T14:24:28Z\"\n\t\t\t]\n\t\t]\n\t)\n);\n\n```\n\nOs dados serão armazenados conforme o index passado.\nNo caso do exemplo acima o recurso será armazenado em \"/history/default\".\n\nO certo seria, utilizarmos um worker, que, quando um log novo for enviado através do método \"Judas-\u003elog()\" para uma fila, envia esse dado para o ElasticSearch, podemos utilizar o **[Hermes](https://bitbucket.org/eduzz/hermes)** para isso.\n\n```php\n\u003c?php\n\n$hermes-\u003eaddQueue('judas_logs')\n\t-\u003ebind('judas.store.info')\n\t-\u003egetLastQueueCreated();\n\n$hermes-\u003eaddListenerTo(\n\t'judas_logs',\n\tfunction($msg) use ($judas) {\n\t\t$judas-\u003estore(json_decode($msg-\u003ebody));\n\t}\n);\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feduzz%2Fjudas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feduzz%2Fjudas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feduzz%2Fjudas/lists"}