PHPackages piwvh/php-eureka - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. piwvh/php-eureka ActiveLibrary[API Development](/categories/api) piwvh/php-eureka ================ A PHP client for Spring Cloud Eureka discovery server. 0.0.3(3y ago)7462.8k↓12.2%22[2 issues](https://github.com/piwvh/php-eureka/issues)1MITPHPPHP >=5.4.0 Since Apr 28Pushed 3y ago6 watchersCompare [ Source](https://github.com/piwvh/php-eureka)[ Packagist](https://packagist.org/packages/piwvh/php-eureka)[ Docs](http://hamid.work)[ RSS](/packages/piwvh-php-eureka/feed)WikiDiscussions master Synced yesterday READMEChangelog (2)Dependencies (1)Versions (4)Used By (1) PHP Netflix Eureka Client ========================= [](#php-netflix-eureka-client) A PHP client for (Spring Cloud) Netflix Eureka service registration and discovery. Installation ------------ [](#installation) You can install this package using [Composer](https://getcomposer.org/): `composer require "piwvh/php-eureka"` Documentation ------------- [](#documentation) ### Create Eureka Client [](#create-eureka-client) The very first thing you need to do is to create an instance of `EurekaClient` using your own configuration: ``` $client = new EurekaClient([ 'eurekaDefaultUrl' => 'http://localhost:8761/eureka', 'hostName' => 'service.hamid.work', 'appName' => 'service', 'ip' => '127.0.0.1', 'port' => ['8080', true], 'homePageUrl' => 'http://localhost:8080', 'statusPageUrl' => 'http://localhost:8080/info', 'healthCheckUrl' => 'http://localhost:8080/health' ]); ``` List of all available configuration are as follows: - `eurekaDefaultUrl` (default: `http://localhost:8761`); - `hostName` - `appName` - `ip` - `status` (default: `UP`) - `overriddenStatus` (default: `UNKNOWN`) - `port` - `securePort` (default: `['443', false]`) - `countryId ` (default: `1`) - `dataCenterInfo` (default: `['com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo', 'MyOwn']`) - `homePageUrl` - `statusPageUrl` - `healthCheckUrl` - `vipAddress` - `secureVipAddress` - `heartbeatInterval` (default: `30`) - `discoveryStrategy` (default: `RandomStrategy`) - `instanceProvider` You can also change the configuration after creating `EurekaClient` instance, using setter methods: ``` $client->getConfig()->setAppName("my-service"); ``` ### Operations [](#operations) After creating EurekaClient instance, there will be multiple operations to perform: - **Registration:** register your service instance with Eureka ``` $client->register(); ``` - **De-registration:** de-register your service instance from Eureka ``` $client->deRegister(); ``` - **Heartbeat:** send heartbeat to Eureka, to show the client is up (one-time heartbeat) ``` $client->heartbeat(); ``` You can register your instance and send periodic heartbeat using `start()` method: ``` $client->start(); ``` Using this method, first your service gets registered with Eureka using the configuration you have provided. Then, a heartbeat will be sent to the Eureka periodically, based on `heartbeatInterval` configuration value. This interval time can be changed just like any other configuration item: ``` $client->getConfig()->setHeartbeatInterval(60); // 60 seconds ``` It's apparent that this method should be used in CLI. - **Service Discovery**: fetch an instance of a service from Eureka: ``` $instance = $client->fetchInstance("the-service"); $homePageUrl = $instance->homePageUrl; ``` ### Discovery Strategy [](#discovery-strategy) When fetching instances of a service from Eureka, you probably get a list of available instances. You can choose one of them based on your desired strategy of load balancing. For example, a Round-robin or a Random strategy might be your choice. Currently, this library only supports `RandomStrategy`, however, you can create your custom strategy by implementing `getInstance()` method of `DiscoveryStrategy` interface: ``` class RoundRobinStrategy implements DiscoveryStrategy { public function getInstance($instances) { // return an instance } } ``` Then, all you have to do is to introduce your custom strategy to `EurekaClient` instance: ``` $client->getConfig()->setDiscoveryStrategy(new RoundRobinStrategy()); ``` ### Local Registry and Caching [](#local-registry-and-caching) Failure is inevitable, specially in cloud-native applications. Thus, sometimes Eureka may not be available because of failure. In these cases, we should have a local registry of services to avoid cascading failures. By default, if Eureka is down, the `fetchInstance()` method fails, so an exception would be thrown and the application cannot continue to work. To solve this problem, you should create a local registry of services. There is an interface called `InstanceProvider` which you can make use of, by implementing `getInstances()` method of this interface and returning instances of a service based on your ideal logic. ``` class MyProvider implements InstanceProvider { public function getInstances($appName) { // return cached instances of the service from the Redis } } ``` In this example, we have cached the instances of the service in the Redis and are loading them when Eureka is down. After creating your custom provider, just make it work by adding it to the configuration: ``` $client->getConfig()->setInstanceProvider(new MyProvider()); ``` Your custom provider only gets called when Eureka is down or is not answering properly. That's all you need to do. By adding this functionality, your application keeps working even when Eureka is down. For caching all available instances of a specific service, you can call `fetchInstances()` method which fetches all of the instances of the service from Eureka: ``` $instances = $client->fetchInstances("the-service"); ``` ### Health Score 36 — LowBetter than 79% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity45 Moderate usage in the ecosystem Community20 Small or concentrated contributor base Maturity50 Maturing project, gaining track record Bus Factor1 Top contributor holds 91.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~788 days Total 3 Last Release 1412d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/7631027?v=4)[Hamid Mohayeji](/maintainers/piwvh)[@piwvh](https://github.com/piwvh) --- Top Contributors [![piwvh](https://avatars.githubusercontent.com/u/7631027?v=4)](https://github.com/piwvh "piwvh (21 commits)")[![thiagobit](https://avatars.githubusercontent.com/u/2165422?v=4)](https://github.com/thiagobit "thiagobit (1 commits)")[![xnkjj](https://avatars.githubusercontent.com/u/16268065?v=4)](https://github.com/xnkjj "xnkjj (1 commits)") --- Tags phpeurekaspring clouddiscovery server ### Embed Badge ![Health badge](/badges/piwvh-php-eureka/health.svg) ``` [![Health](https://phpackages.com/badges/piwvh-php-eureka/health.svg)](https://phpackages.com/packages/piwvh-php-eureka) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3741.3M47](/packages/tencentcloud-tencentcloud-sdk-php)[resend/resend-php Resend PHP library. 617.2M43](/packages/resend-resend-php)[checkout/checkout-sdk-php Checkout.com SDK for PHP 563.6M13](/packages/checkout-checkout-sdk-php)[eslazarev/wildberries-sdk Wildberries OpenAPI clients (generated). 273.0k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk Files.com PHP SDK 2481.1k](/packages/filescom-files-php-sdk)[aimeos/prisma A powerful PHP package for integrating media related Large Language Models (LLMs) into your applications 1943.1k5](/packages/aimeos-prisma) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)