PHPackages                             lucas-simoes/eureka-client-php - 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. lucas-simoes/eureka-client-php

ActiveLibrary[API Development](/categories/api)

lucas-simoes/eureka-client-php
==============================

A PHP client for Spring Cloud Eureka discovery server.

0.0.2(8y ago)02.2kMITPHPPHP >=5.4.0

Since Apr 28Pushed 6y agoCompare

[ Source](https://github.com/lucas-simoes/php-eureka)[ Packagist](https://packagist.org/packages/lucas-simoes/eureka-client-php)[ Docs](http://hamid.work)[ RSS](/packages/lucas-simoes-eureka-client-php/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (1)Versions (3)Used By (0)

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 easily 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 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 includes:

- `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 configuration after creating `EurekaClient` instance, using setter methods:

```
$client->getConfig()->setAppName("my-service");
```

### Operations

[](#operations)

After creating EurekaClient instance, there will be multiple operations you can do:

- **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 determine the client is up (one-time heartbeat)

```
$client->heartbeat();
```

You can register your instance and send periodic heartbeat using `start()` method:

```
$client->start();
```

With this method, first your service gets registered with Eureka using the configuration you have provided. After that, 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 obvious 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`, but 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 or distributed applications. So, sometimes Eureka may not be available because of failure. In this cases, we should have a local registry of services to avoid cascading failures.

By default, if Eureka is down, the `fetchInstance()` method fails, so the application throws an exception and can not continue to work. To solve this problem, you should create a local registry in your application.

There is an interface called `InstanceProvider` which you can make use of. You should implement `getInstances()` method of this interface and return 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 database
    }
}
```

In this example, we have cached the instances of the service in the database 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 it. 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

25

—

LowBetter than 35% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 94.7% 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 ~0 days

Total

2

Last Release

2987d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/49e455a8f8cc2e5318d88366b01f3ed23183f15d87086f857435a7c73d939147?d=identicon)[lucas-simoes](/maintainers/lucas-simoes)

---

Top Contributors

[![piwvh](https://avatars.githubusercontent.com/u/7631027?v=4)](https://github.com/piwvh "piwvh (18 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/lucas-simoes-eureka-client-php/health.svg)

```
[![Health](https://phpackages.com/badges/lucas-simoes-eureka-client-php/health.svg)](https://phpackages.com/packages/lucas-simoes-eureka-client-php)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[piwvh/php-eureka

A PHP client for Spring Cloud Eureka discovery server.

7462.8k1](/packages/piwvh-php-eureka)[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)[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)