org.torproject.metricsbot

Class RelayTweetGenerator

java.lang.Object

org.torproject.metricsbot.RelayTweetGenerator

public class RelayTweetGenerator
extends java.lang.Object

Tweet generator functions for relay specific tweets.

Author:

Iain R. Learmonth <irl@torproject.org>

Constructor Summary

Constructors

Constructor and Description
RelayTweetGenerator()

Method Summary

Modifier and Type	Method and Description
static MicroblogStatus	generateAgeTweet(RelayImpl relay) Returns a tweet about how long the relay has been contributing to the Tor network.
static MicroblogStatus	generateBandwidthTweet(RelayImpl relay) Returns a tweet about how much bandwidth a relay is contributing to the Tor network.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelayTweetGenerator

public RelayTweetGenerator()

Method Detail

generateAgeTweet

public static MicroblogStatus generateAgeTweet(RelayImpl relay)
                                        throws MissingInformationException

Returns a tweet about how long the relay has been contributing to the Tor network.

An example tweet looks like:

Aramis66 in United States has been contributing to the #Tor network for 154 days and 2 hours. https://atlas.torproject.org/#details/637BD268843638713D6FC13A92B3E36F4B5B0F4B

This function requires that "country_name" has a useful value in the RelayDetails object.

Parameters:

relay - A RelayDetails object for the relay to have a tweet generated.

Returns:

A tweet about how long the relay has been contributing to the Tor network.

Throws:

MissingInformationException - when information required to generate the tweet is missing from the RelayDetails object (probably because Onionoo did not have it)

generateBandwidthTweet

public static MicroblogStatus generateBandwidthTweet(RelayImpl relay)
                                              throws MissingInformationException

Returns a tweet about how much bandwidth a relay is contributing to the Tor network.

An example tweet looks like:

BeastieJoy60 in Germany is contributing 11.1MiB/s bandwidth to the #Tor network. https://atlas.torproject.org/#details/B86137AE9681701901C6720E55C16805B46BD8E3

This function requires that both "country_name" and "advertised_bandwidth" have useful values in the RelayDetails object. "advertised_bandwidth" is not considered useful is "measured" is false in the Onionoo document.

Parameters:

relay - A RelayDetails object for the relay to have a tweet generated.

Returns:

A tweet about how much bandwidth the relay is contributing to the Tor network.

Throws:

MissingInformationException - when information required to generate the tweet is missing from the RelayDetails object (probably because Onionoo did not have it)