graphite-project / carbon

Missing module/function docstring PY-D0003
Documentation
Minor
22 occurrences in this check
Docstring missing for setDebugEnabled
207debugEnabled = False
208
209
210def setDebugEnabled(enabled):211  global debugEnabled
212  debugEnabled = enabled
Docstring missing for debug
199  msg(message, **context)
200
201
202def debug(message, **context):203  if debugEnabled:
204    msg(message, **context)
205
Docstring missing for query
194  msg(message, **context)
195
196
197def query(message, **context):198  context['type'] = 'query'
199  msg(message, **context)
200
Docstring missing for aggregator
189  msg(message, **context)
190
191
192def aggregator(message, **context):193  context['type'] = 'aggregator'
194  msg(message, **context)
195
Docstring missing for relay
184  msg(message, **context)
185
186
187def relay(message, **context):188  context['type'] = 'relay'
189  msg(message, **context)
190
Docstring missing for listener
179  msg(message, **context)
180
181
182def listener(message, **context):183  context['type'] = 'listener'
184  msg(message, **context)
185
Docstring missing for updates
174  msg(message, **context)
175
176
177def updates(message, **context):178  context['type'] = 'updates'
179  msg(message, **context)
180
Docstring missing for creates
169  msg(message, **context)
170
171
172def creates(message, **context):173  context['type'] = 'creates'
174  msg(message, **context)
175
Docstring missing for clients
164  msg(message, **context)
165
166
167def clients(message, **context):168  context['type'] = 'clients'
169  msg(message, **context)
170
Docstring missing for cache
159  startLoggingWithObserver(carbonLogObserver)
160
161
162def cache(message, **context):163  context['type'] = 'cache'
164  msg(message, **context)
165
Docstring missing for logToStdout
155logToSyslog = carbonLogObserver.log_to_syslog
156
157
158def logToStdout():159  startLoggingWithObserver(carbonLogObserver)
160
161
Docstring missing for formatEvent
137carbonLogObserver = CarbonLogObserver()
138
139
140def formatEvent(event, includeType=False):141  event['isError'] = 'failure' in event
142  message = textFromEventDict(event)
143
Docstring missing for logdir_observer
119    stdout.write(formatEvent(event, includeType=True) + '\n')
120    stdout.flush()
121
122  def logdir_observer(self, event):123    message = formatEvent(event)
124    log_type = event.get('type')
125
Docstring missing for stdout_observer
115    return self.observer(event)
116
117  @staticmethod
118  def stdout_observer(event):119    stdout.write(formatEvent(event, includeType=True) + '\n')
120    stdout.flush()
121
Docstring missing for syslog_observer
105  def log_to_syslog(self, prefix):
106    observer = SyslogObserver(prefix).emit
107
108    def syslog_observer(event):109      event["system"] = event.get("type", "console")
110      observer(event)
111    self.observer = syslog_observer
Docstring missing for log_to_syslog
102    self.custom_logs = {}
103    self.observer = self.logdir_observer
104
105  def log_to_syslog(self, prefix):106    observer = SyslogObserver(prefix).emit
107
108    def syslog_observer(event):
Docstring missing for log_to_dir
 96      (f.type, f.value, f.getTracebackObject())
 97    )
 98
 99  def log_to_dir(self, logdir):100    self.logdir = logdir
101    self.console_logfile = CarbonLogFile('console.log', logdir)
102    self.custom_logs = {}
Docstring missing for log_to_raven
 85    self._raven_client = raven.Client(dsn=settings.RAVEN_DSN)
 86    return self._raven_client
 87
 88  def log_to_raven(self, event): 89    if not event.get('isError') or 'failure' not in event:
 90      return
 91    client = self.raven_client()
Docstring missing for raven_client
 69  def __init__(self):
 70    self._raven_client = None
 71
 72  def raven_client(self): 73    if self._raven_client is not None:
 74      return self._raven_client
 75
Docstring missing for reopen
 58    DailyLogFile.write(self, data)
 59
 60  # Backport from twisted >= 10
 61  def reopen(self): 62    self.close()
 63    self._openFile()
 64
Docstring missing for write
 46    else:
 47      return False
 48
 49  def write(self, data): 50    if not self.enableRotation:
 51      if not os.path.exists(self.path):
 52        self.reopen()
Docstring missing for shouldRotate
 40    self._file.seek(0, os.SEEK_END)
 41    self.lastDate = self.toDate(os.stat(self.path)[8])
 42
 43  def shouldRotate(self): 44    if self.enableRotation:
 45      return DailyLogFile.shouldRotate(self)
 46    else: