{"id":27131305,"url":"https://github.com/majusko/grpc-apm-spring-boot-starter","last_synced_at":"2025-04-07T20:53:01.591Z","repository":{"id":37864117,"uuid":"220683394","full_name":"majusko/grpc-apm-spring-boot-starter","owner":"majusko","description":"Spring boot starter for gRPC framework with Elastic APM","archived":false,"fork":false,"pushed_at":"2023-03-06T09:59:57.000Z","size":152,"stargazers_count":22,"open_issues_count":9,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T15:38:43.917Z","etag":null,"topics":["apm-tracer","elastic-apm","elasticsearch","grpc","grpc-framework","grpc-interceptor","grpc-java","grpc-library","interceptor","java","lognet-grpc-library","spring-boot","springboot","springboot-starter","tracing"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/majusko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-09T18:10:48.000Z","updated_at":"2025-02-07T09:02:15.000Z","dependencies_parsed_at":"2023-02-12T01:01:38.583Z","dependency_job_id":null,"html_url":"https://github.com/majusko/grpc-apm-spring-boot-starter","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majusko%2Fgrpc-apm-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majusko%2Fgrpc-apm-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majusko%2Fgrpc-apm-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majusko%2Fgrpc-apm-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/majusko","download_url":"https://codeload.github.com/majusko/grpc-apm-spring-boot-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247729929,"owners_count":20986400,"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":["apm-tracer","elastic-apm","elasticsearch","grpc","grpc-framework","grpc-interceptor","grpc-java","grpc-library","interceptor","java","lognet-grpc-library","spring-boot","springboot","springboot-starter","tracing"],"created_at":"2025-04-07T20:53:01.010Z","updated_at":"2025-04-07T20:53:01.572Z","avatar_url":"https://github.com/majusko.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring boot starter for [gRPC framework](https://grpc.io/) with [Elastic APM tracer](https://www.elastic.co/products/apm) \n\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.majusko/grpc-apm-spring-boot-starter/badge.svg)](https://search.maven.org/search?q=g:io.github.majusko)\n[![Release](https://jitpack.io/v/majusko/grpc-apm-spring-boot-starter.svg)](https://jitpack.io/#majusko/grpc-apm-spring-boot-starter)\n[![Build Status](https://travis-ci.com/majusko/grpc-apm-spring-boot-starter.svg?branch=master)](https://travis-ci.com/majusko/grpc-apm-spring-boot-starter)\n[![Test Coverage](https://codecov.io/gh/majusko/grpc-apm-spring-boot-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/majusko/grpc-apm-spring-boot-starter/branch/master)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the chat at https://gitter.im/grpc-apm-spring-boot-starter/community](https://badges.gitter.im/grpc-apm-spring-boot-starter/community.svg)](https://gitter.im/grpc-apm-spring-boot-starter/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nExtending great [LogNet gRPC Spring Boot Starter library](https://github.com/LogNet/grpc-spring-boot-starter) with APM tracer module. Easy implementation using a prepared interceptor beans ready for registration.\n\n## Quick Start\n\nQuick start consist only from 2 simple steps.\n\n- If you never used [LogNet gRPC library](https://github.com/LogNet/grpc-spring-boot-starter) before, have a look on this [basic setup](https://github.com/LogNet/grpc-spring-boot-starter#4-show-case) first.\n- If you never used [Elastic APM tracer](https://www.elastic.co/products/apm) before, have a look on this [basic setup](https://www.elastic.co/guide/en/apm/agent/java/1.x/setup.html) first.\n\n#### 1. Add Maven dependency\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eio.github.majusko\u003c/groupId\u003e\n  \u003cartifactId\u003egrpc-apm-spring-boot-starter\u003c/artifactId\u003e\n  \u003cversion\u003e${version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n#### 2. Add interceptor to client\n\nJust autowire already prepared `ApmClientInterceptor` bean and intercept your client. Every request using this client is traced from now on.\n\n```java\n@Service\npublic class ExampleClient {\n\n    @Autowired\n    private ApmClientInterceptor apmClientInterceptor;\n\n    public void exampleRequest() {\n        final ManagedChannel channel = ManagedChannelBuilder.forTarget(target).usePlaintext().build();\n        final Channel interceptedChannel = ClientInterceptors.intercept(channel, apmClientInterceptor);\n        final ExampleServiceBlockingStub stub = ExampleServiceGrpc.newBlockingStub(interceptedChannel);\n        \n        stub.getExample(GetExample.newBuilder().build());\n    }\n}\n```\n\n### Tests\n\nThe library is fully covered with integration tests which are also very useful as a usage example.\n\n`GrpcApmSpringBootStarterApplicationTest`\n\n## Contributing\n\nAll contributors are welcome. If you never contributed to the open-source, start with reading the [Github Flow](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/github-flow).\n\n1. Create an [issue](https://help.github.com/en/github/managing-your-work-on-github/about-issues)\n2. Create a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) with reference to the issue\n3. Rest and enjoy the great feeling of being a contributor.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajusko%2Fgrpc-apm-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmajusko%2Fgrpc-apm-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajusko%2Fgrpc-apm-spring-boot-starter/lists"}