1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Logger\Monolog;
use AvroIODatumWriter;
use AvroIOBinaryEncoder;
use AvroIOTypeException;
use AvroSchema;
use AvroStringIO;
use AvroValidator;
use Monolog\Formatter\FormatterInterface;
/**
* Log message formatter that uses the apache Avro format.
*
* @since 1.26
* @author Erik Bernhardson <ebernhardson@wikimedia.org>
* @copyright © 2015 Erik Bernhardson and Wikimedia Foundation.
*/
class AvroFormatter implements FormatterInterface {
/**
* @var Magic byte to encode schema revision id.
*/
const MAGIC = 0x0;
/**
* @var array Map from schema name to schema definition
*/
protected $schemas;
/**
* @var AvroStringIO
*/
protected $io;
/**
* @var AvroIOBinaryEncoder
*/
protected $encoder;
/**
* @var AvroIODatumWriter
*/
protected $writer;
/**
* @param array $schemas Map from Monolog channel to Avro schema.
* Each schema can be either the JSON string or decoded into PHP
* arrays.
*/
public function __construct( array $schemas ) {
$this->schemas = $schemas;
$this->io = new AvroStringIO( '' );
$this->encoder = new AvroIOBinaryEncoder( $this->io );
$this->writer = new AvroIODatumWriter();
}
/**
* Formats the record context into a binary string per the
* schema configured for the records channel.
*
* @param array $record
* @return string|null The serialized record, or null if
* the record is not valid for the selected schema.
*/
public function format( array $record ) {
$this->io->truncate();
$schema = $this->getSchema( $record['channel'] );
$revId = $this->getSchemaRevisionId( $record['channel'] );
if ( $schema === null || $revId === null ) {
trigger_error( "The schema for channel '{$record['channel']}' is not available" );
return null;
}
try {
$this->writer->write_data( $schema, $record['context'], $this->encoder );
} catch ( AvroIOTypeException $e ) {
$errors = AvroValidator::getErrors( $schema, $record['context'] );
$json = json_encode( $errors );
trigger_error( "Avro failed to serialize record for {$record['channel']} : {$json}" );
return null;
}
return chr( self::MAGIC ) . $this->encodeLong( $revId ) . $this->io->string();
}
/**
* Format a set of records into a list of binary strings
* conforming to the configured schema.
*
* @param array $records
* @return string[]
*/
public function formatBatch( array $records ) {
$result = [];
foreach ( $records as $record ) {
$message = $this->format( $record );
if ( $message !== null ) {
$result[] = $message;
}
}
return $result;
}
/**
* Get the writer for the named channel
*
* @param string $channel Name of the schema to fetch
* @return \AvroSchema|null
*/
protected function getSchema( $channel ) {
if ( !isset( $this->schemas[$channel] ) ) {
return null;
}
if ( !isset( $this->schemas[$channel]['revision'], $this->schemas[$channel]['schema'] ) ) {
return null;
}
if ( !$this->schemas[$channel]['schema'] instanceof AvroSchema ) {
$schema = $this->schemas[$channel]['schema'];
if ( is_string( $schema ) ) {
$this->schemas[$channel]['schema'] = AvroSchema::parse( $schema );
} else {
$this->schemas[$channel]['schema'] = AvroSchema::real_parse(
$schema
);
}
}
return $this->schemas[$channel]['schema'];
}
/**
* Get the writer for the named channel
*
* @param string $channel Name of the schema
* @return int|null
*/
public function getSchemaRevisionId( $channel ) {
if ( isset( $this->schemas[$channel]['revision'] ) ) {
return (int)$this->schemas[$channel]['revision'];
}
return null;
}
/**
* convert an integer to a 64bits big endian long (Java compatible)
* NOTE: certainly only compatible with PHP 64bits
* @param int $id
* @return string the binary representation of $id
*/
private function encodeLong( $id ) {
$high = ( $id & 0xffffffff00000000 ) >> 32;
$low = $id & 0x00000000ffffffff;
return pack( 'NN', $high, $low );
}
}
|
