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
172
173
174
175
176
177
178
179
180
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.spark.util.logging
import java.io.{File, FileOutputStream, InputStream, IOException}
import org.apache.spark.SparkConf
import org.apache.spark.internal.Logging
import org.apache.spark.util.{IntParam, Utils}
/**
* Continuously appends the data from an input stream into the given file.
*/
private[spark] class FileAppender(inputStream: InputStream, file: File, bufferSize: Int = 8192)
extends Logging {
@volatile private var outputStream: FileOutputStream = null
@volatile private var markedForStop = false // has the appender been asked to stopped
// Thread that reads the input stream and writes to file
private val writingThread = new Thread("File appending thread for " + file) {
setDaemon(true)
override def run() {
Utils.logUncaughtExceptions {
appendStreamToFile()
}
}
}
writingThread.start()
/**
* Wait for the appender to stop appending, either because input stream is closed
* or because of any error in appending
*/
def awaitTermination() {
writingThread.join()
}
/** Stop the appender */
def stop() {
markedForStop = true
}
/** Continuously read chunks from the input stream and append to the file */
protected def appendStreamToFile() {
try {
logDebug("Started appending thread")
Utils.tryWithSafeFinally {
openFile()
val buf = new Array[Byte](bufferSize)
var n = 0
while (!markedForStop && n != -1) {
try {
n = inputStream.read(buf)
} catch {
// An InputStream can throw IOException during read if the stream is closed
// asynchronously, so once appender has been flagged to stop these will be ignored
case _: IOException if markedForStop => // do nothing and proceed to stop appending
}
if (n > 0) {
appendToFile(buf, n)
}
}
} {
closeFile()
}
} catch {
case e: Exception =>
logError(s"Error writing stream to file $file", e)
}
}
/** Append bytes to the file output stream */
protected def appendToFile(bytes: Array[Byte], len: Int) {
if (outputStream == null) {
openFile()
}
outputStream.write(bytes, 0, len)
}
/** Open the file output stream */
protected def openFile() {
outputStream = new FileOutputStream(file, false)
logDebug(s"Opened file $file")
}
/** Close the file output stream */
protected def closeFile() {
outputStream.flush()
outputStream.close()
logDebug(s"Closed file $file")
}
}
/**
* Companion object to [[org.apache.spark.util.logging.FileAppender]] which has helper
* functions to choose the correct type of FileAppender based on SparkConf configuration.
*/
private[spark] object FileAppender extends Logging {
/** Create the right appender based on Spark configuration */
def apply(inputStream: InputStream, file: File, conf: SparkConf): FileAppender = {
import RollingFileAppender._
val rollingStrategy = conf.get(STRATEGY_PROPERTY, STRATEGY_DEFAULT)
val rollingSizeBytes = conf.get(SIZE_PROPERTY, STRATEGY_DEFAULT)
val rollingInterval = conf.get(INTERVAL_PROPERTY, INTERVAL_DEFAULT)
def createTimeBasedAppender(): FileAppender = {
val validatedParams: Option[(Long, String)] = rollingInterval match {
case "daily" =>
logInfo(s"Rolling executor logs enabled for $file with daily rolling")
Some(24 * 60 * 60 * 1000L, "--yyyy-MM-dd")
case "hourly" =>
logInfo(s"Rolling executor logs enabled for $file with hourly rolling")
Some(60 * 60 * 1000L, "--yyyy-MM-dd--HH")
case "minutely" =>
logInfo(s"Rolling executor logs enabled for $file with rolling every minute")
Some(60 * 1000L, "--yyyy-MM-dd--HH-mm")
case IntParam(seconds) =>
logInfo(s"Rolling executor logs enabled for $file with rolling $seconds seconds")
Some(seconds * 1000L, "--yyyy-MM-dd--HH-mm-ss")
case _ =>
logWarning(s"Illegal interval for rolling executor logs [$rollingInterval], " +
s"rolling logs not enabled")
None
}
validatedParams.map {
case (interval, pattern) =>
new RollingFileAppender(
inputStream, file, new TimeBasedRollingPolicy(interval, pattern), conf)
}.getOrElse {
new FileAppender(inputStream, file)
}
}
def createSizeBasedAppender(): FileAppender = {
rollingSizeBytes match {
case IntParam(bytes) =>
logInfo(s"Rolling executor logs enabled for $file with rolling every $bytes bytes")
new RollingFileAppender(inputStream, file, new SizeBasedRollingPolicy(bytes), conf)
case _ =>
logWarning(
s"Illegal size [$rollingSizeBytes] for rolling executor logs, rolling logs not enabled")
new FileAppender(inputStream, file)
}
}
rollingStrategy match {
case "" =>
new FileAppender(inputStream, file)
case "time" =>
createTimeBasedAppender()
case "size" =>
createSizeBasedAppender()
case _ =>
logWarning(
s"Illegal strategy [$rollingStrategy] for rolling executor logs, " +
s"rolling logs not enabled")
new FileAppender(inputStream, file)
}
}
}
|
