Skip to content

Commit 828a0de

Browse files
mhujerpolyfractal
authored andcommitted
Drop Monolog dependency from ClientBuilder (#674)
* rebuild docs * drop Monolog dependency from ClientBuilder
1 parent a037712 commit 828a0de

File tree

6 files changed

+5
-80
lines changed

6 files changed

+5
-80
lines changed

BREAKING_CHANGES.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# 6.0
22

33
- [Search Templates]: PutTemplate endpoint has been removed (see [Elasticsearch Breaking Changes](https://www.elastic.co/guide/en/elasticsearch/reference/current/breaking_60_scripting_changes.html#_stored_search_template_apis_removed)),
4-
use PutScript instead.
4+
use PutScript instead.
5+
6+
- [#674](https://github.com/elastic/elasticsearch-php/pull/674) `ClientBuilder::defaultLogger()` method was removed. It is recommended to [create the logger object manually](https://github.com/elastic/elasticsearch-php/blob/master/docs/configuration.asciidoc#enabling-the-logger).

docs/build/Elasticsearch/Client.asciidoc

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ The class defines the following methods:
4646
* <<Elasticsearch_ClientputScript_putScript,`putScript()`>>
4747
* <<Elasticsearch_ClientgetTemplate_getTemplate,`getTemplate()`>>
4848
* <<Elasticsearch_ClientdeleteTemplate_deleteTemplate,`deleteTemplate()`>>
49-
* <<Elasticsearch_ClientputTemplate_putTemplate,`putTemplate()`>>
5049
* <<Elasticsearch_ClientfieldStats_fieldStats,`fieldStats()`>>
5150
* <<Elasticsearch_ClientfieldCaps_fieldCaps,`fieldCaps()`>>
5251
* <<Elasticsearch_ClientrenderSearchTemplate_renderSearchTemplate,`renderSearchTemplate()`>>
@@ -1033,27 +1032,6 @@ $response = $client->deleteTemplate($params);
10331032

10341033

10351034

1036-
[[Elasticsearch_ClientputTemplate_putTemplate]]
1037-
.`putTemplate()`
1038-
****
1039-
[source,php]
1040-
----
1041-
/*
1042-
$params['id'] = (string) The search template ID (Required)
1043-
['body'] = (array) Request body
1044-
*/
1045-
1046-
$params = [
1047-
// ...
1048-
];
1049-
1050-
$client = ClientBuilder::create()->build();
1051-
$response = $client->putTemplate($params);
1052-
----
1053-
****
1054-
1055-
1056-
10571035
[[Elasticsearch_ClientfieldStats_fieldStats]]
10581036
.`fieldStats()`
10591037
****

docs/build/Elasticsearch/ClientBuilder.asciidoc

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ The class defines the following methods:
2020
* <<Elasticsearch_ClientBuilderdefaultHandler_defaultHandler,`defaultHandler()`>>
2121
* <<Elasticsearch_ClientBuildermultiHandler_multiHandler,`multiHandler()`>>
2222
* <<Elasticsearch_ClientBuildersingleHandler_singleHandler,`singleHandler()`>>
23-
* <<Elasticsearch_ClientBuilderdefaultLogger_defaultLogger,`defaultLogger()`>>
2423
* <<Elasticsearch_ClientBuildersetConnectionFactory_setConnectionFactory,`setConnectionFactory()`>>
2524
* <<Elasticsearch_ClientBuildersetConnectionPool_setConnectionPool,`setConnectionPool()`>>
2625
* <<Elasticsearch_ClientBuildersetEndpoint_setEndpoint,`setEndpoint()`>>
@@ -157,19 +156,6 @@ corresponds to setConnectionPool().
157156

158157

159158

160-
[[Elasticsearch_ClientBuilderdefaultLogger_defaultLogger]]
161-
.`defaultLogger()`
162-
****
163-
[source,php]
164-
----
165-
/*
166-
*/
167-
168-
----
169-
****
170-
171-
172-
173159
[[Elasticsearch_ClientBuildersetConnectionFactory_setConnectionFactory]]
174160
.`setConnectionFactory()`
175161
****

docs/build/renderer.index

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
C:19:"Sami\Renderer\Index":1041:{a:3:{i:0;a:10:{s:20:"Elasticsearch\Client";s:40:"6ac4061ad03df8cddeaec31a8bfb556fc7a33e71";s:27:"Elasticsearch\ClientBuilder";s:40:"30fa910e5653bf5f7096369ef1529a47da7e3e92";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"a9d466909dc08564e9c1516162c3a6bb91dbecbe";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"577bab662735319b93ed7b555cd2b12b73e40680";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"66391991c19f28764c86e9604e231b9ce004c82e";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"9bd2962d80e3c0cdcaedda4f23b722b3a8cfa013";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"da4e71f9d953d00600920c26fe585b6884e45f94";s:40:"Elasticsearch\Namespaces\RemoteNamespace";s:40:"a503f6ea82452e1ea0275a044aeb527bc946616d";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"e28a1807789b0fcca3fd6b9712ed713650cf7ac2";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"2de86d7ab409a629320725f6444c76d2a9313c72";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}}
1+
C:19:"Sami\Renderer\Index":1041:{a:3:{i:0;a:10:{s:20:"Elasticsearch\Client";s:40:"1815e70d1a9613e61fbe3bf14e3c77e4321c3b31";s:27:"Elasticsearch\ClientBuilder";s:40:"824023c8ff5d33cd7085f75ff88b436b5dde0482";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"a9d466909dc08564e9c1516162c3a6bb91dbecbe";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"577bab662735319b93ed7b555cd2b12b73e40680";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"66391991c19f28764c86e9604e231b9ce004c82e";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"9bd2962d80e3c0cdcaedda4f23b722b3a8cfa013";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"da4e71f9d953d00600920c26fe585b6884e45f94";s:40:"Elasticsearch\Namespaces\RemoteNamespace";s:40:"a503f6ea82452e1ea0275a044aeb527bc946616d";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"e28a1807789b0fcca3fd6b9712ed713650cf7ac2";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"2de86d7ab409a629320725f6444c76d2a9313c72";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}}

docs/configuration.asciidoc

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -180,34 +180,7 @@ And then update your composer installation:
180180
php composer.phar update
181181
----------------------------
182182

183-
Once Monolog (or another logger) is installed, you need to create a log object and inject it into the client. The
184-
`ClientBuilder` object has a helper static function that will generate a common Monolog-based logger for you. All you need
185-
to do is provide the path to your desired logging location:
186-
187-
[source,php]
188-
----
189-
$logger = ClientBuilder::defaultLogger('path/to/your.log');
190-
191-
$client = ClientBuilder::create() // Instantiate a new ClientBuilder
192-
->setLogger($logger) // Set the logger with a default logger
193-
->build(); // Build the client object
194-
----
195-
196-
You can also specify the severity of log messages that you wish to log:
197-
198-
[source,php]
199-
----
200-
// set severity with second parameter
201-
$logger = ClientBuilder::defaultLogger('/path/to/logs/', Logger::INFO);
202-
203-
$client = ClientBuilder::create() // Instantiate a new ClientBuilder
204-
->setLogger($logger) // Set the logger with a default logger
205-
->build(); // Build the client object
206-
----
207-
208-
The `defaultLogger()` method is just a helper, you are not required to use it. You can create your own logger and inject
209-
that instead:
210-
183+
Once Monolog (or another logger) is installed, you need to create a log object and inject it into the client:
211184

212185
[source,php]
213186
----

src/Elasticsearch/ClientBuilder.php

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -212,20 +212,6 @@ public static function singleHandler()
212212
}
213213
}
214214

215-
/**
216-
* @param $path string
217-
* @param int $level
218-
* @return \Monolog\Logger\Logger
219-
*/
220-
public static function defaultLogger($path, $level = Logger::WARNING)
221-
{
222-
$log = new Logger('log');
223-
$handler = new StreamHandler($path, $level);
224-
$log->pushHandler($handler);
225-
226-
return $log;
227-
}
228-
229215
/**
230216
* @param \Elasticsearch\Connections\ConnectionFactoryInterface $connectionFactory
231217
* @return $this

0 commit comments

Comments
 (0)