An open API service indexing awesome lists of open source software.

https://github.com/midoks/php-eureka-client

PHP client for the Netflix Eureka server
https://github.com/midoks/php-eureka-client

Last synced: 9 months ago
JSON representation

PHP client for the Netflix Eureka server

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/midoks/php-eureka-client.svg?branch=master)](https://travis-ci.org/midoks/php-eureka-client)

# PHP Eureka Client

PHP client for the [Netflix Eureka server](https://github.com/Netflix/eureka). Supports all [Eureka REST operations](https://github.com/Netflix/eureka/wiki/Eureka-REST-operations).

## Installation
Run
```
composer require midoks/php-eureka-client
```
or add dependency to your composer.json file
```
"require": {
...
"midoks/php-eureka-client": "^1.0"
}

```
## Usage example
### 1. Use needed packages
```php
use Eureka\Client;
```
### 2. Create Eureka app instance
```php
// We will use app name and instance id for making requests below.
$client = new \Euraka\Client($this->host, $this->port, $this->context);

```
### 3. Create Eureka client
```php

// Create eureka v2 client.
$client = new EurekaClient('localhost', 8080);

// Create eureka v1 client.
$client = new EurekaClient('localhost', 8080, 'eureka');
```
### 4. Make requests
```php
try {
// Register new application instance.
$response = $client->registerApp($appName, $instance);

// Query for all instances.
$allApps = $client->getAllApps();

// Query for all application instances.
$app = $client->getApp($appName);

// Query for a specific application instance.
$appInstance = $client->getAppInstance($appName, $instanceId);

// Query for a specific instance.
$instance = $client->getInstance($instanceId);

// Send application instance heartbeat.
$response = $client->heartBeat($appName, $instanceId);

// Take instance out of service.
$response = $client->takeInstanceOut($appName, $instanceId);

// Put instance back into service.
$response = $client->putInstanceBack($appName, $instanceId);

// Update metadata.
$response = $client->updateAppInstanceMetadata($appName, $instanceId, [
'new_key' => 'new_value',
]);

// Query for all instances under a particular vip address/
$instances = $client->getInstancesByVipAddress('test_vip_address');

// Query for all instances under a particular secure vip address.
$instances = $client->getInstancesBySecureVipAddress('test_secure_vip_address');

// De-register application instance.
$response = $client->deRegisterApp($appName, $instanceId);
}
catch (Exception $e) {
echo $e->getMessage() . PHP_EOL;
}
```