module TsdMetrics

Licensed 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.

Licensed 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.

Licensed 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.

Licensed 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.

Licensed 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.

Licensed 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.

Licensed 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.

Constants

UNITS
VERSION

Attributes

errorLogger[R]

Public Class Methods

buildMetric() click to toggle source

# File lib/tsd_metrics.rb, line 75
def self.buildMetric
  init() if @metricBuilder == nil
  @metricBuilder.build
end

init(providedOpts={}) click to toggle source

filename: Optional: the relative or absolute path to output metrics. Default: 'query.log' in the working directory
errorLogger: Optional: a place to which mis-uses of the library can be logged.

Expects methods +info+, +warn+, +error+

rollLogs: Optional: Have the library do log rolling; not thread-safe! Setting to false means the library-user should have external log-rolling in place. Default: true

# File lib/tsd_metrics.rb, line 32
def self.init(providedOpts={})
  defaultOpts = {filename: "query.log", rollLogs: true}
  opts = defaultOpts.merge providedOpts
  @errorLogger = opts[:errorLogger] || Logger.new(STDOUT)

  outputFileQueue = Queue.new

  # JSON to queue
  writer = QueueWriter.new(outputFileQueue)

  # Metric to JSON
  formatterStructReveiver = JsonFormattingSink.new(writer)
  @metricBuilder = MetricBuilderForSingleStructReceiver.new(formatterStructReveiver)

  loggerOptions = [opts[:filename]]
  # Set the ':daily' option on the logger if we want to roll the logs
  loggerOptions.push(:daily) if opts[:rollLogs]
  # TODO(mhayter): Switch to hourly rolling (will need different log lib)
  # [MAI-173]
  # File writer
  toFileLogger = createHeaderlessLogger(*loggerOptions)

  # Queue to file
  @queueToFileWriter = AsyncQueueWriter.new(outputFileQueue, toFileLogger)
  @queueToFileWriter.start

  # Phusion Passenger loses all threads on a fork, this is added
  # so that the writing thread is recreated.
  # This code was found at
  # https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html#_smart_spawning_caveat_2_the_need_to_revive_threads
  if defined?(PhusionPassenger)
    PhusionPassenger.on_event(:starting_worker_process) do |forked|
      if forked
        outputFileQueue.clear
        @queueToFileWriter.start
      else
        # We're in direct spawning mode. We don't need to do anything.
      end
    end
  end

end

Private Class Methods

createHeaderlessLogger(*args) click to toggle source

# File lib/tsd_metrics.rb, line 82
def self.createHeaderlessLogger(*args)
  # Disable the logger header
  Logger::LogDevice.class_eval do
    alias orig_add_log_header add_log_header

    def add_log_header(file)
    end
  end

  # Quick, create an instance
  logger = Logger.new(*args)

  # Restore the old method:
  Logger::LogDevice.class_eval do
    alias add_log_header orig_add_log_header
  end

  logger
end

Private Instance Methods

add_log_header(file) click to toggle source

# File lib/tsd_metrics.rb, line 87
def add_log_header(file)
end